Referens
Alla anrop i version 1. Bas-adressen är https://newsletter.qrona.se/api/v1. Hela beskrivningen finns också som OpenAPI 3.1 för Postman och kodgeneratorer.
Nyckeln
Kontrollera att nyckeln fungerar, vilken arbetsyta den gäller och vad den får göra.
Kontakter
Kontakterna är arbetsytans mottagare. En kontakt identifieras av sin e-postadress, som aldrig ändras. Skapa bara kontakter som har samtyckt till utskick (eller där ni har en annan rättslig grund): en aktiv kontakt kan nås av utskick till distributionslistor även om den inte är med på någon lista.
- GET
/contactsLista kontakterKontakterna som nyckeln får se, i id-ordning, en sida i taget. - POST
/contactsSkapa kontaktEn ny kontakt i arbetsytan. Finns adressen redan blir svaret 409 contact_exists. - POST
/contacts/upsertSkapa eller uppdatera kontaktSkapar kontakten om adressen är ny, annars uppdateras den. Det vanliga anropet för en integration. - POST
/contacts/lookupSlå upp kontakter på e-postUpp till 100 adresser i ett anrop. Svaret har de kontakter som finns (alla statusar, även raderade). - GET
/contacts/{id}Hämta kontaktEn kontakt med de listor den är med på. - PATCH
/contacts/{id}Ändra kontaktÄndrar de fält du skickar. E-postadressen kan inte ändras. - POST
/contacts/{id}/unsubscribeAvregistrera kontaktPersonen vill inte ha fler utskick: kontakten lämnar alla listor, får status unsubscribed och adressen spärras. - POST
/contacts/{id}/eraseRadera kontakt (GDPR)Raderar kontaktens personuppgifter för gott. Adressen spärras så att den aldrig får utskick igen.
Listor
Listor är publiker med eget anmälningsläge: med dubbel opt-in måste nya anmälningar bekräfta via e-post.
- GET
/listsLista listorArbetsytans listor med antal medlemmar. - POST
/listsSkapa listaEn ny lista. Dubbel opt-in är på om du inte säger annat. - GET
/lists/{id}Hämta listaEn lista med antal medlemmar. - PATCH
/lists/{id}Ändra listaNamn, beskrivning och anmälningsläge. - DELETE
/lists/{id}Ta bort listaTar bort listan. Kontakterna finns kvar. Går inte medan en kampanj som ska skickas använder listan.
Listmedlemmar
Vilka som är med på en lista, och anmälningar till den. Anmälningar via API:t följer samma regler som formulären: den som har avregistrerat sig eller spärrats kommer aldrig med utan att själv bekräfta.
- GET
/lists/{id}/membersLista medlemmarListans medlemmar, en sida i taget. - POST
/lists/{id}/membersAnmäl till listaAnmäler en adress till listan, med beviset för samtycket. Kontakten skapas om den inte finns. - DELETE
/lists/{id}/members/{contact_id}Ta bort från listaTar bort kontakten från listan (en administrativ ändring, inte en avregistrering).
Kontaktfält
Arbetsytans egna fält – de nycklar som kan användas i fields på en kontakt.
Distributionslistor
Distributionslistor är kontakter som uppfyller villkor (segment). Kräver att personen bakom nyckeln är administratör.
Spärrlista
Adresser som arbetsytan aldrig skickar till: avregistrerade, studsande, skräppostanmälningar och spärrar som lagts in för hand.
Butiker
En webbutik i arbetsytan. Allt i e-handeln hör till en butik och namnges med butikens egna id:n, som ni väljer. PUT skapar eller uppdaterar, så att samma anrop kan göras om utan att något dubbleras. Guide: e-handel
- GET
/storesLista butikerArbetsytans butiker med hur mycket var och en har skickat in. - GET
/stores/{store_id}Hämta butikEn butik. - PUT
/stores/{store_id}Skapa eller uppdatera butikSkapar butiken med ert id, eller uppdaterar den. Det första anropet för en webbutik. - DELETE
/stores/{store_id}Ta bort butikTar bort butiken och allt i den: kunder, produkter, ordrar och kundkorgar. Kan inte ångras.
Kunder
De som har handlat i butiken – med eller utan samtycke till utskick. En kund blir aldrig en kontakt: den kopplas till arbetsytans kontakt med samma adress så länge en sådan finns, för köpvillkor i distributionslistor. Kunder och samtycke
- GET
/stores/{store_id}/customersLista kunderButikens kunder, en sida i taget. - GET
/stores/{store_id}/customers/{customer_id}Hämta kundEn kund med antal betalda ordrar och summan av dem. - PUT
/stores/{store_id}/customers/{customer_id}Skapa eller uppdatera kundSkapar kunden med butikens id, eller uppdaterar den. Ordrar och korgar gör det här själva med sin kund. - DELETE
/stores/{store_id}/customers/{customer_id}Ta bort kundTar bort kunden och hens kundkorgar. Ordrarna finns kvar utan kund, så att kampanjernas intäkt stämmer.
Produkter
Butikens produkter med varianter, för villkor som ”har köpt produkt X”. Guide: e-handel
- GET
/stores/{store_id}/productsLista produkterButikens produkter med varianter, en sida i taget. - GET
/stores/{store_id}/products/{product_id}Hämta produktEn produkt med varianter. - PUT
/stores/{store_id}/products/{product_id}Skapa eller uppdatera produktSkapar produkten med butikens id, eller uppdaterar den. Skickas variants ersätter de alla varianter. - DELETE
/stores/{store_id}/products/{product_id}Ta bort produktTar bort produkten och dess varianter. Orderrader som nämner den finns kvar.
Ordrar
Butikens ordrar med rader. Betalda ordrar räknas som köp i villkor och som intäkt för kampanjen kunden kom från (campaign_id). Intäkt per kampanj
- GET
/stores/{store_id}/ordersLista ordrarButikens ordrar med rader, en sida i taget. - GET
/stores/{store_id}/orders/{order_id}Hämta orderEn order med rader. - PUT
/stores/{store_id}/orders/{order_id}Skapa eller uppdatera orderSkapar ordern med butikens id, eller uppdaterar den – skicka ordern igen när den ändras (betald, återbetald, avbruten). - DELETE
/stores/{store_id}/orders/{order_id}Ta bort orderTar bort ordern. En avbruten eller återbetald order skickas hellre med sin nya status.
Kundkorgar
Öppna kundkorgar. Ta bort korgen när den har blivit en order. Guide: e-handel
- GET
/stores/{store_id}/cartsLista kundkorgarButikens öppna kundkorgar, en sida i taget. - GET
/stores/{store_id}/carts/{cart_id}Hämta kundkorgEn kundkorg med rader. - PUT
/stores/{store_id}/carts/{cart_id}Skapa eller uppdatera kundkorgSkapar korgen med butikens id, eller uppdaterar den. Raderna ersätter de tidigare. - DELETE
/stores/{store_id}/carts/{cart_id}Ta bort kundkorgTar bort korgen, till exempel när den har blivit en order.
Intäkt
Intäkten per kampanj: de betalda ordrar som kom från kampanjens länkar. Intäkt per kampanj
Batch
Upp till 500 anrop i ett, till exempel för att läsa in gamla ordrar. Varje operation kontrolleras och körs som om den skickats för sig. Batch och idempotens
Meddelanden
Ett meddelande i taget till en mottagare, gjort av en Qrona-mall och meddelandets egen data. Bara för tillägget Byråstöd: Klientkommunikation, med Qronas systemnyckel – en persons nyckel kan inte skicka meddelanden. Guide: meddelanden från Qrona
Qrona-mallar
Mallarna meddelandena görs av, designade i Qrona Newsletter mot ett datakontrakt. Förhandsgranska en mall med data, precis som den skickas. Mallar och datakontrakt
Webhooks
Adresser som får höra om anmälningar, avregistreringar, studsar och skräppostanmälningar i arbetsytan, signerade med HMAC. Kräver att personen bakom nyckeln är administratör. Guide: webhooks
- GET
/webhooksLista webhooksArbetsytans webhooks. - POST
/webhooksSkapa webhookEn ny webhook. Svaret har hemligheten som leveranserna signeras med – den visas bara nu. - GET
/webhooks/{id}Hämta webhookEn webhook och hur dess leveranser går. - PATCH
/webhooks/{id}Ändra webhookAdress, händelser och beskrivning, eller stäng av och slå på den. - DELETE
/webhooks/{id}Ta bort webhookTar bort webhooken. Leveranser som väntar skickas inte. - GET
/webhooks/{id}/deliveriesLista leveranserWebhookens leveranser de senaste 30 dagarna, nyaste först: vad som skickades, hur mottagaren svarade och när nästa försök görs. - POST
/webhooks/{id}/testTesta webhookSkickar en ping till adressen direkt och svarar med hur det gick. Görs inte om.