Datakilder og API

Sådan sender du poster til en datakilde med Sendtric API’et

Sidst opdateret

Med en API-datakilde sender dit eget system JSON-poster til Sendtric, hver gang dine data ændres. Sendtric gemmer dem som hostede data, og dine billeder henter den enkelte abonnents post, når en e-mail åbnes.

Denne vejledning er beregnet til den, der skriver koden, der sender dataene. Hvis du hellere vil have, at Sendtric henter data fra dit API, hver gang siden åbnes, kan du læse hvordan du forbinder en datakilde til dit eget API.

Opret datakilden

  1. Klik i venstre sidepanel på Datakilder, og derefter Ny datakilde.
  2. Under APIskal du vælge API og klik på Fortsæt.
  3. Vælg Send data til Sendtric og klik på Fortsæt.
  4. Udfyld:
    • Navn på datakilde: for eksempel "Loyalitetsmedlemmer".
    • Felt til unik identifikator: det JSON-felt, der identificerer hver post, f.eks. customer_id eller email. Hver post, du sender, skal indeholde det.
    • Beskrivelse (valgfrit).
  5. Klik Gem datakilde. Datakilden oprettes, og API viser dine endpoints og din API-nøgle.
  6. Kopier det, du har brug for, og klik derefter på Fortsæt for at afslutte.
API-trinnet for en ny datakilde, der viser endpointene til opslag og opdatering af enkeltposter samt masseopslag og -opdatering, API-nøglen og eksempler på anmodninger

Du kan til enhver tid finde slutpunkterne igen i datakildens API-detaljer .

Log ind

Send din nøgle i Authorization overskriften på hver anmodning:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Den API-nøglen til datakilden fungerer kun til at sende datakildeposter, så den kan trygt gives til en udvikler eller et automatiseringsværktøj. Hvis du har et API-abonnement, fungerer din eksisterende API-abonnementsnøgle også på disse endpoints.

Hold din nøgle væk fra frontend-kode og offentlige repositorier. Hvis den på et tidspunkt bliver afsløret, skal du generere den på ny under Indstillinger → API-nøgler → API-nøgle til datakilde, og opdater derefter alt, der bruger den.

Opret eller opdater poster

Send et enkelt JSON-objekt eller en række objekter til det endpoint, der vises i Sendtric. Én post:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

Flere poster i én forespørgsel:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

Sådan gemmes optegnelser:

  • Hvis der endnu ikke findes en post med den pågældende identifikator, oprettes der en ny.
  • Hvis man gør det, er det erstattet med det, du har sendt. Felter, du udelader, fjernes, så send altid den fulde post.
  • Nye og opdaterede poster er som regel tilgængelige inden for cirka et minut.
  • Identifikatorer sammenlignes uden hensyn til store og små bogstaver.

En vellykket anmodning returnerer 200 med et kort resumé, for eksempel {"status":"ok","records":2}.

Du kan indlejre objekter i en post, for eksempel "address": { "city": "Leeds" }, og vælge indlejrede felter i billedredigeringsprogrammet.

Slet poster

Slet en post ved at tilføje dens identifikator i slutningen af endpointet:

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

Slet flere ved at sende en række identifikatorer:

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

Grænser

GrænseVærdi
Antal poster pr. forespørgsel10.000
Anmodningens størrelse10 MB
Identifikatorværdi255 tegn
En vilkårlig tekstværdi10 KB
Indlejringsdybde20 niveauer

Send poster i batcher i stedet for én anmodning pr. post. Ved tusindvis af poster, se hvordan man sender store mængder data til en datakilde.

Svar og fejl

StatusHvad det betyderHvad skal man gøre?
200Registreringer godkendtIntet. Hvis nogle poster blev sprunget over, angiver X-Skipped-Records-overskriften, hvor mange der er
400Teksten er ikke gyldig JSONKontroller anmodningens indhold
401Manglende eller forkert API-nøgleKontroller »Authorization«-overskriften
404Der blev ikke fundet nogen datakilde for denne nøgleKontroller slutpunktet, og at nøglen tilhører den samme konto
413For mange poster eller for storOpdel anmodningen i mindre portioner
422Det var ikke muligt at gemme postenMeddelelsen angiver, hvilke poster der mangler identifikatorfeltet, eller som er for store
503Sendtric har travltVent det antal sekunder, der er angivet i »Retry-After«-headeren, og send derefter den samme anmodning igen

Når kun nogle poster i en forespørgsel er ugyldige, gemmes de gyldige stadig, mens de øvrige springes over.

Tjek dine optegnelser

Åbn datakilden, og gå til fanen "Poster" . Søg efter identifikatorværdi, og klik på en post for at se den fulde JSON-fil, som Sendtric har gemt.

Næste trin

Var denne artikel nyttig?

Klik på billedet for at zoome ind. Træk eller rul for at se dig omkring.