APIREST · OpenAPI 3.1
Ett typet REST-API for hele plattformen.
Alt Medal-appene gjør er tilgjengelig over HTTPS på https://io.medalsocial.com/api/v1 — innlegg, e-post, kontakter og avtaler, bookinger, portal, GDPR, scan, helpdesk, webhooks, kanaler, kapasitetsbekreftelser og arbeidsområder.
Fra API-nøkkel til første svar.
bashDin første forespørselcurl https://io.medalsocial.com/api/v1/posts \ -H "Authorization: Bearer $MEDAL_API_KEY"
Autentiser
Lag en API-nøkkel i innstillingene for arbeidsområdet og send den som Authorization: Bearer medal_… — nøkler gjelder kun ett arbeidsområde, så en integrasjon kan aldri nå feil data. OAuth-tokens fungerer også; kombiner dem med en x-workspace-id-header slik at forespørselen treffer riktig arbeidsområde.
Én base-URL, alle ressurser
https://io.medalsocial.com/api/v1 dekker innlegg, e-post, kontakter, avtaler, bookinger, portal, GDPR, scan, helpdesk, webhooks, kanaler, kapasitetsbekreftelser og arbeidsområder. Alt går inn og ut som JSON.
jsonFeil kommer som JSON{ "error": { "code": "UNAUTHORIZED", "message": "Missing or invalid Authorization header" } }
Rategrenser, gjenforsøk og paginering
Lesing er begrenset til 300 forespørsler per minutt (burst 100) og skriving til 60 per minutt (burst 30). E-postsending tillater 100 per minutt, e-postbatch 10 per minutt, kontaktimport 5 per minutt og GDPR-eksport 5 per time. Trekk deg tilbake ved 429 og respekter Retry-After. Liste-endepunkter pagineres med cursor: send next_cursor tilbake for å hente neste side.
Verifiser hver webhook
Leveranser har en X-Medal-Signature-header — en HMAC-SHA256 over {timestamp}.{rawBody} — sammen med X-Medal-Timestamp. Regn ut signaturen på nytt over rå-kroppen og sammenlign før du stoler på innholdet.
En validert OpenAPI 3.1-kontrakt
Det finnes ingen offentlig OpenAPI-URL. Den validerte kontrakten ligger i npm-pakken i stedet — @medalsocial/sdk/openapi.json, openapi.yaml og openapi-types — så du kan generere klienter, mock-servere eller agentverktøy fra en versjon du selv låser.