Recuperación de subcuentas

Para recuperar la información desde las subcuentas, hay dos métodos :

Por la plataforma :
Al ir a su tablero de instrumentos donde tendrá acceso a todas las subcuentas asociadas a su cuenta.

Por la API :
Mediante la realización de una consulta en la siguiente URL.

UR

GET https://api.smspartner.fr/v1/subaccount/list

Configuraciones

Cada solicitud de API es compatible con los siguientes parámetros :

apiKey	Clave de API de su cuenta. Usted lo consigue en su Cuenta de SMS Partner
page	El número de página, hay 20 resultados por página. Si se omite, se devolverá la página 1.
Ajustes opcionales
_format	Formato de la respuesta. Se puede elegir entre `JSON` o `XML`. Por defecto, el formato de respuesta es `JSON`.

Solicitud

Ejemplo de solicitud :

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/list?'.$data);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
 
 
        $result = curl_exec($curl);
        curl_close($curl);
 
        // Process your response here
        echo $result;
?>

<?php

// Prepare data for GET request

$data = 'apiKey=YOUR_API_KEY';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/list?'.$data);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt($curl, CURLOPT_TIMEOUT, 10);

$result = curl_exec($curl);

curl_close($curl);

// Process your response here

echo $result;

Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.smspartner.fr/v1/"
    Dim apiKey As String = "VOTRE_APIKEY"
 
    #check credits
    Dim url As String
    url = base_url & "subaccount/list" & "?apiKey=" & apiKey
 
    Dim credits As String
    credits = apiRequest("GET", url, Nothing)
 
  End Sub
 
  Function apiRequest(method As String, url As String, parameters As String) As String
 
    Dim request As HttpWebRequest
    request = WebRequest.Create(url)
    request.Method = method
    request.Timeout = 10000   # timeout in ms
    request.ContentType = "application/json; charset=utf-8"
    request.ContentLength = 0
 
    #set POST data
    If Not String.IsNullOrEmpty(parameters) Then
      request.ContentLength = parameters.Length
      Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())
        reqStream.Write(parameters)
      End Using
    End If
 
    #get response
    Dim returnValue As String = Nothing
    Using response As HttpWebResponse = request.GetResponse()
      If response.StatusCode = HttpStatusCode.OK Then
        Using resStream = response.GetResponseStream()
          If resStream IsNot Nothing Then
            Using reader As New StreamReader(resStream)
              returnValue = reader.ReadToEnd()
            End Using
          End If
        End Using
      End If
    End Using
    apiRequest = returnValue
 
  End Function
 
End Module

Imports System.IO

Imports System.Net

Module Module1

Sub Main()

Dim base_url As String = "http://api.smspartner.fr/v1/"

Dim apiKey As String = "VOTRE_APIKEY"

#check credits

Dim url As String

url = base_url & "subaccount/list" & "?apiKey=" & apiKey

Dim credits As String

credits = apiRequest("GET", url, Nothing)

End Sub

Function apiRequest(method As String, url As String, parameters As String) As String

Dim request As HttpWebRequest

request = WebRequest.Create(url)

request.Method = method

request.Timeout = 10000 # timeout in ms

request.ContentType = "application/json; charset=utf-8"

request.ContentLength = 0

#set POST data

If Not String.IsNullOrEmpty(parameters) Then

request.ContentLength = parameters.Length

Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())

reqStream.Write(parameters)

End Using

End If

#get response

Dim returnValue As String = Nothing

Using response As HttpWebResponse = request.GetResponse()

If response.StatusCode = HttpStatusCode.OK Then

Using resStream = response.GetResponseStream()

If resStream IsNot Nothing Then

Using reader As New StreamReader(resStream)

returnValue = reader.ReadToEnd()

End Using

End If

End Using

End If

End Using

apiRequest = returnValue

End Function

End Module

# std
import logging
import json
from collections import OrderedDict
 
# 3p
import requests
 
API_KEY = "MY API KEY"
URL = "https://api.smspartner.fr/v1"
 
class SMSPartner():
    def get_list_subaccount(self):
		url = URL + "/subaccount/list?apiKey=" + API_KEY
		r = requests.get(url)
		r_json = r.json()
		if r_json.get("success") == True:
			print(r_json)
			status = True
		else:
			print(r_json)
			status = False
		return status

# std

import logging

import json

from collections import OrderedDict

# 3p

import requests

API_KEY = "MY API KEY"

URL = "https://api.smspartner.fr/v1"

class SMSPartner():

def get_list_subaccount(self):

url = URL + "/subaccount/list?apiKey=" + API_KEY

r = requests.get(url)

r_json = r.json()

if r_json.get("success") == True:

print(r_json)

status = True

else:

print(r_json)

status = False

return status

curl -H  "Content-Type: application/json" -X GET  https://api.smspartner.fr/v1/subaccount/list?apiKey=xxx&page=1

1	curl -H "Content-Type: application/json" -X GET https://api.smspartner.fr/v1/subaccount/list?apiKey=xxx&page=1

{
  "success": true,
  "code": 200,
  "total": 29,
  "nb_per_page": 20,
  "page": 1,
  "data": [
    {
      "id": 1,
      "email": "email1",
      "type": "simple",
      "token": "token1", //Est utilisé comme identifiant du sous-compte pour ajouter des crédits
      "apiKey": "ApiKey sous compte",
      "createdAt": "2016-03-04 11:23:14",
      "credits": {
          "balance": "0.800",
          "currency": "EUR"
      }
    },
    {
      "id": 2,
      "email": "email2",
      "type": "simple",
      "token": "token2",
      "apiKey": "ApiKey2 du sous compte",
      "createdAt": "2016-03-04 11:23:14",
      "credits": {
          "balance": "10.245",
          "currency": "EUR"
      }
    }
  ]
}

{

"success": true,

"code": 200,

"total": 29,

"nb_per_page": 20,

"page": 1,

"data": [

{

"id": 1,

"email": "email1",

"type": "simple",

"token": "token1", //Est utilisé comme identifiant du sous-compte pour ajouter des crédits

"apiKey": "ApiKey sous compte",

"createdAt": "2016-03-04 11:23:14",

"credits": {

"balance": "0.800",

"currency": "EUR"

}

{

"id": 2,

"email": "email2",

"type": "simple",

"token": "token2",

"apiKey": "ApiKey2 du sous compte",

"createdAt": "2016-03-04 11:23:14",

"credits": {

"balance": "10.245",

"currency": "EUR"

}

]

}

<?xml version="1.0" encoding="UTF-8"?>
    <entry>true</entry>
    <entry>200</entry>
    <entry>20</entry>
    <entry>1</entry>
    <entry>2</entry>
    <entry>
        <entry>
            <entry>1</entry>
            <entry>
                <![CDATA[email1]]>
            </entry>
            <entry>
                <![CDATA[2016-03-04 11:23:14]]>
            </entry>
            <entry>
                <entry>670</entry>
                <entry>
                    <![CDATA[4]]>
                </entry>
                <entry>666</entry>
 
            </entry>
 
        </entry>
        <entry>
            <entry>2</entry>
            <entry>
                <![CDATA[email2]]>
            </entry>
            <entry xsi:nil="true"/>
            <entry>
                <![CDATA[2016-03-05 09:14:47]]>
            </entry>
            <entry>
                <entry>110</entry>
                <entry>0</entry>
                <entry>110</entry>
 
            </entry>
 
        </entry>
 
    </entry>
</result>

<?xml version="1.0" encoding="UTF-8"?>

<entry>

<entry>

<![CDATA[email1]]>

</entry>

<entry>

<![CDATA[2016-03-04 11:23:14]]>

</entry>

<entry>

<entry>

<![CDATA[4]]>

</entry>

</entry>

<entry>

<entry>

<![CDATA[email2]]>

</entry>

<entry>

<![CDATA[2016-03-05 09:14:47]]>

</entry>

<entry>

</entry>

</result>

Errores

Ejemplo de mensaje de error :

JSON
XML

{
  "success": false,
  "code": 10,
  "message": "Clé API incorrecte"
}

{

"success": false,

"code": 10,

"message": "Clé API incorrecte"

}

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry>false</entry>
    <entry>10</entry>
    <entry>
        <![CDATA[Clé API incorrecte]]>
    </entry>
</result>

<?xml version="1.0" encoding="UTF-8"?>

<entry>false</entry>

<entry>

<![CDATA[Clé API incorrecte]]>

</entry>

</result>

Código de control

	Respuesta
1	Se requiere la clave de la API
10	Clave API incorrecta
200	¡Todo paso bien!

Lista de subcuentas

Recuperación de subcuentas

UR

GET https://api.smspartner.fr/v1/subaccount/list

Configuraciones

Solicitud

Respuestas

Errores

Código de control