Liste des sous-comptes

Cette requête est utilisée pour lister les sous-comptes de votre compte principal.

URL

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

Paramètres obligatoires

Nom	Valeur
apiKey	Votre clé API
page	Le numéro de la page, il y a 20 résultats par page. Si ce paramètre est laissé vide la page 1 sera retourné.

Paramètre optionnel

Nom	Valeur
_format	json ou xml

Requêtes

PHP

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.mailpartner.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;
?>

VB.net

Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.mailpartner.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

Python

# std
import logging
import json
from collections import OrderedDict
 
# 3p
import requests
 
API_KEY = "MY API KEY"
URL = "https://api.mailpartner.fr/v1"
 
class MailPartner():
    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

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

Réponse

json

{
  "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

<?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>

Erreurs

json

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

xml

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

Code erreurs

Code de réponse	Réponse
1	La Clé API est requise
10	Clé API incorrecte
200	Tout s'est bien passé !