v1

Liste der verfügbaren Dienste und Länder abrufen

POST{yourserver}/getServices

Diese Anfrage wird jede Minute vom OnlineSIM-Server an Ihren Server gesendet, um die Anzahl der verfügbaren Nummern abzufragen. Ihr Server sollte die aktuellen Anzahlen im unten beschriebenen Format zurückgeben.

Alle v1-Anfragen sind JSON-POST-Anfragen (Content-Type: application/json) an die einzige URL Ihrer Integration; die Methode wird im Feld action übergeben, Ihr Partner-API-Schlüssel im Feld key. Es wird kein Authorization-Header gesendet. Nur der JSON-Body Ihrer Antwort wird gelesen; ihr HTTP-Statuscode wird nicht geprüft.

Anforderungs-Body

Anfragetext vom OnlineSIM-Server

Content-Typeapplication/json
Schema
schemaobject
actionstringErforderlich
Name der Methode, in diesem Fall GET_SERVICESEnumeration:GET_SERVICESBeispiel:GET_SERVICES
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey

Beispiele

request

GET_SERVICES-Anfrage vom OnlineSIM-Server

{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Antworten

200Die Antwort Ihres Servers auf GET_SERVICES
Content-Typeapplication/json
Schema
schemaobject
countryListobject[]Liste der Länder mit der Anzahl verfügbarer Nummern pro Betreiber und Dienst. Länder und Dienste, die OnlineSIM nicht kennt, werden ignoriert; negative Anzahlen werden als 0 gelesen.Beispiel:[ { "country": "russia", "operatorMap": { "any": { "vk": 10, "ok": 25, "wa": 52 } } } ]
statusstringErforderlich
SUCCESS mit einer nicht leeren countryList; NO_PROVIDER - derzeit nichts anzubieten (gilt nicht als Fehler); jeder andere Wert ist ein FehlerEnumeration:SUCCESSNO_PROVIDERERRORBeispiel:SUCCESS

Beispiele

withAnyZeilen: 25

Anzahlen mit dem Betreiber any

{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132
        }
      }
    }
  ],
  "status": "SUCCESS"
}
perOperatorZeilen: 25

Anzahlen pro Betreiber, ohne any

{
  "countryList": [
    {
      "country": "ukraine",
      "operatorMap": {
        "life": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        },
        "vodafone": {
          "vk": 10,
          "ok": 10,
          "wa": 0
        },
        "kyivstar": {
          "vk": 0,
          "ok": 30,
          "wa": 100
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Codebeispiele

Beispiele werden generiert...