Konto och underkonton

Endpointsen för konto och underkonton tillhör en äldre, fortfarande operativ API-struktur. De använder /api/... i stället för den versionerade /v2/...-basen som resten av SMS API-referensen.

Fullständig URL byggs mot https://api.ip1sms.com.

Kontoöversikt

Metod	Sökväg
GET	/api/me

{
  "Account": "ip1-XXXXX",
  "Organization": "Företaget",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK"
}

Fält	Beskrivning
Account	Kontots ID med prefixet ip1-.
Organization	Organisationens namn.
Type	Publicerade värden är swedish och international.
Balance	Saldo, som kan vara positivt eller negativt beroende på betalningsmodell.
Currency	SEK eller EUR.

Kontodetaljer

Metod	Sökväg
GET	/api/me/account

{
  "Key": "REDACTED",
  "Parent": "ip1-PARENT",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK",
  "ID": "ip1-XXXXX",
  "Name": "Avdelning"
}

Key är en autentiseringshemlighet. Returnera den aldrig till webbläsaren, skriv den inte i loggar och exponera den inte i analys- eller felrapporter.

Skapa underkonto

Metod	Sökväg
POST	/api/me/children

{
  "Name": "Support"
}

Svaret använder kontodatatypen nedan.

Lista underkonton

Metod	Sökväg	Beskrivning
GET	/api/me/children	Lista samtliga underkonton.
GET	/api/me/children/{child}	Läs ett underkonto.

Den äldre sidan saknade ett snedstreck före {child}. Sökvägen ovan följer mönstret som används på uppdateringssidan.

Uppdatera underkonto

Metod	Sökväg
PUT	/api/me/children/{child}

{
  "ID": "ip1-CHILD",
  "Name": "Nytt namn"
}

Kontodatatyp för underkonto

{
  "Key": "REDACTED",
  "Parent": "ip1-PARENT",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK",
  "ID": "ip1-CHILD",
  "Name": "Support"
}

Fält	Beskrivning
Key	Underkontots API-nyckel. Behandla som hemlighet.
Parent	Huvudkontots ID.
Type	Kontotyp.
Balance	Underkontots saldo.
Currency	Underkontots valuta.
ID	Underkontots ID.
Name	Namn eller verksamhetsreferens.

Skapa separata nycklar och minsta möjliga behörighet för varje integration. Undvik att distribuera huvudkontots nyckel till system som bara behöver ett underkonto.