Gegevensbronnen & API

Hoe stuur je records naar een gegevensbron met de Sendtric API?

Laatst bijgewerkt

Met een API-gegevensbron stuurt je eigen systeem JSON-records naar Sendtric zodra je gegevens veranderen. Sendtric slaat deze op als gehoste gegevens, en je afbeeldingen halen het record van elke abonnee op wanneer een e-mail wordt geopend.

Deze handleiding is bedoeld voor iedereen die de code schrijft waarmee de gegevens worden verzonden. Als je liever hebt dat Sendtric bij elke keer openen gegevens uit je API haalt, kijk dan bij hoe je een gegevensbron aan je eigen API koppelt.

Maak de gegevensbron aan

  1. Klik in de linkerzijbalk op Gegevensbronnenen vervolgens Nieuwe gegevensbron.
  2. Onder APIkies je API en klik op Doorgaan.
  3. Kies 'Gegevens naar Sendtric verzenden' en klik op Doorgaan.
  4. Vul het volgende in:
    • Naam van de gegevensbron: bijvoorbeeld "Loyaliteitsleden".
    • Veld voor unieke identificatiecode: het JSON-veld dat elk record identificeert, zoals customer_id of email. Elk record dat je verstuurt, moet dit veld bevatten.
    • Beschrijving (optioneel).
  5. Klik op Op 'Gegevensbron opslaan'. De gegevensbron wordt aangemaakt en de API -stap toont je eindpunten en API-sleutel.
  6. Kopieer wat je nodig hebt en klik dan op Doorgaan om af te ronden.
Het API-gedeelte van een nieuwe gegevensbron, met daarin de eindpunten voor het toevoegen of bijwerken van één record en in bulk, de API-sleutel en voorbeeldverzoeken

Je kunt de eindpunten op elk moment weer terugvinden in de tabblad 'API-details' van de gegevensbron.

Inloggen

Zet je sleutel in de Authorization header van elk verzoek:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

De API-sleutel voor gegevensbronnen werkt alleen voor het verzenden van gegevensbronrecords, dus je kunt deze gerust aan een ontwikkelaar of een automatiseringstool geven. Als je een API-abonnement hebt, werkt je bestaande API-sleutel ook op deze eindpunten.

Houd je sleutel uit de front-end-code en openbare repositories. Mocht hij ooit openbaar worden, genereer hem dan opnieuw via Instellingen → API-sleutels → API-sleutel voor gegevensbron, en werk vervolgens alles bij waar deze sleutel wordt gebruikt.

Records aanmaken of bijwerken

POST één JSON-object of een array met objecten naar het eindpunt dat in Sendtric wordt weergegeven. Eén record:

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

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

Meerdere records in één verzoek:

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 }
]

Hoe gegevens worden opgeslagen:

  • Als er nog geen record met die identificatiecode bestaat, wordt er een nieuw record aangemaakt.
  • Als je dat doet, is het wordt vervangen door wat je hebt gestuurd. Velden die je weglaat, worden verwijderd, dus stuur altijd het volledige record.
  • Nieuwe en bijgewerkte gegevens zijn meestal binnen ongeveer een minuut beschikbaar.
  • Bij het vergelijken van identificatiecodes wordt geen onderscheid gemaakt tussen hoofdletters en kleine letters.

Een succesvol verzoek levert 200 een korte samenvatting, bijvoorbeeld {"status":"ok","records":2}.

Je kunt objecten in een record nesten, bijvoorbeeld "address": { "city": "Leeds" }, en in de afbeeldingseditor de geneste velden selecteren.

Records verwijderen

Verwijder één record door de identificatiecode ervan aan het einde van het eindpunt toe te voegen:

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

Verwijder er meerdere door een reeks ID’s te sturen:

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

["cust_1001", "cust_1002"]

Beperkingen

LimietWaarde
Aantal records per verzoek10.000
Grootte van het verzoek10 MB
Waarde van de identificatiecode255 tekens
Elke willekeurige tekstwaarde10 KB
Nestdiepte20 levels

Stuur records in batches in plaats van één verzoek per record. Voor duizenden records, zie hoe je grote hoeveelheden gegevens naar een gegevensbron kunt sturen.

Reacties en fouten

StatusWat dit betekentWat moet je doen?
200Geaccepteerde recordsNiets. Als er nummers zijn overgeslagen, staat in de X-Skipped-Records-header hoeveel
400De inhoud is geen geldige JSONControleer de inhoud van het verzoek
401Ontbrekende of verkeerde API-sleutelControleer de Authorization-header
404De gegevensbron voor deze sleutel is niet gevondenControleer het eindpunt en of de sleutel bij hetzelfde account hoort
413Te veel records of te grootVerdeel het verzoek in kleinere delen
422Er kon geen record worden opgeslagenIn het bericht staat welke records het identificatieveld missen of te groot zijn
503Sendtric heeft het drukWacht het aantal seconden dat in de Retry-After-header staat, en stuur dan hetzelfde verzoek nog een keer

Als slechts enkele records in een verzoek ongeldig zijn, worden de geldige records toch opgeslagen en worden de overige overgeslagen.

Controleer je gegevens

Open de gegevensbron en ga naar de tabblad 'Records' . Zoek op de waarde van de identificatiecode en klik op een record om de volledige JSON-gegevens te zien die Sendtric heeft opgeslagen.

Volgende stap

Was dit artikel nuttig?

Klik op de afbeelding om in te zoomen. Sleep of scrol om rond te kijken.