§ 05 — Ändringslogg

Det här skiljer API-versionerna åt.

Octany har två API-versioner. Kontoinställningen bestämmer standardversionen, och headern Octany-Version väljer en annan för ett enskilt anrop. Se API-versioner för hur du väljer. Här står vad som skiljer versionerna åt och vad som har ändrats i båda.

§ 05.1 Version 2 #

Version 2 beskriver givaren som en kontakt och utelämnar den gamla kundposten och länkarna till fakturaportalen. Nya konton börjar på version 2.

Område	Version 1	Version 2
Givaren på prenumerationer och ordrar	`customer_id` och `customer`, som pekar på den gamla kundposten.	`contact`: hela kontakten, med samma form som `GET /contacts/{id}`, inklusive `metadata`. `null` när ingen kontakt är kopplad.
Länkar till fakturaportalen på prenumerationer	`update_card_url`, `invoices_url` och `cancel_url`.	Utelämnas. Fakturaportalen ersätter dem senare. Tills dess skickar du givare till kundportalen.
Webhook-envelopet	Inget `version`-fält.	`"version": 2` bredvid `name`.

Allt annat är likadant i båda versionerna: produkter, kontakter, webhook-endpoints, fel och alla andra fält på prenumerationer och ordrar.

Samma prenumeration i båda versionerna

Version 1 (förkortad)

{
  "id": 76963688,
  "customer_id": 519461363,
  "price": 9900,
  "status": "active",
  "update_card_url": "https://octanybilling.com/…",
  "invoices_url": "https://octanybilling.com/…",
  "cancel_url": "https://octanybilling.com/…",
  "customer": { "id": 519461363 }
}

Version 2 (förkortad)

{
  "id": 76963688,
  "contact": {
    "id": 1042,
    "type": "person",
    "name": "Anna Persson",
    "email": "[email protected]",
    "metadata": { "crm_id": "CRM-1001" }
  },
  "price": 9900,
  "status": "active"
}

§ 05.2 Alla versioner #

De här ändringarna lägger bara till saker, så de gäller båda versionerna.

Headern Octany-Version. Skicka den för att välja version för ett enskilt anrop. Varje svar returnerar den med versionen som användes, och ett värde som inte stöds ger 400.
metadata på kontakter. Spara dina egna ID:n på en kontakt med POST eller PATCH /contacts. Nycklarna slås ihop, och null tar bort en. En ändring av enbart metadata skickar inget contact.updated. Se kontakter.
subscription.updated vid beloppsändringar. Eventet skickas nu också när beloppet ändras, oavsett om det sker i portalen, i admin eller via en prisändring på produkten. Se subscription.updated.

§ 05.3 Uppgradera #

Flytta en integration i taget. Version 1 fortsätter fungera under tiden.

Skicka Octany-Version: 2 från integrationen och läs contact i stället för customer_id och customer. Matcha givare på contact.id, eller på ditt eget ID i contact.metadata.
Sluta läsa update_card_url, invoices_url och cancel_url. Länka i stället givare till kundportalen.
Ta emot fältet version i webhook-envelopet.
När alla integrationer klarar version 2 byter du kontot i admin under Inställningar → API-nycklar genom att klicka på API-version. Webhooks följer kontoinställningen.

← API-referens Webhooks →