REST API:n pikaopas

REST API:n avulla omat järjestelmäsi voivat työskennellä suoraan Zippendo-palvelun kanssa, joten verkkokauppasi, ERP- tai varastojärjestelmäsi voi luoda lähetyksiä, lukea tilauksia ja hakea osoitekortteja ilman, että kukaan avaa sovellusta. Kaikki julkiset rajapintakutsut on lueteltu API reference -välilehdellä, jossa on leikkikenttä pyyntöjen kokeilemiseen.

1. Luo API-token

Avaa API-asetukset

Avaa osoitteessa app.zippendo.com organisaatiovalikko sivupalkin alareunasta, napsauta Hallitse ja sitten API-asetukset.

Luo token

Napsauta Lisää API-token, anna sille nimi (esimerkiksi Production WMS), valitse tarvittavat Oikeudet ja napsauta Luo token. Kopioi token heti: se näytetään vain kerran.

Säilytä se turvallisesti

API-tokenit alkavat tunnuksella zipp_. Käsittele niitä kuin salasanoja: säilytä ne ympäristömuuttujissa, älä koskaan versionhallinnassa.

Oikeuksista, voimassaoloajasta, brändirajauksesta ja tokenien poistamisesta lisää sivulla API-asetukset.

2. Hae organisaatiosi ID

Jokainen rajapintakutsu ottaa organisaatiosi ID:n (orgId) polussa. Kysy Zippendo-palvelulta, mihin organisaatioon tokenisi kuuluu:

curl -X POST https://api.zippendo.com/api-tokens/verify \
  -H "Content-Type: application/json" \
  -d '{ "token": "zipp_YOUR_TOKEN" }'

Vastauksessa on orgId sekä tokenin scopes ja expiresAt.

3. Tee ensimmäinen pyyntö

Lähetä token Bearer-tunnisteena jokaisessa pyynnössä:

curl https://api.zippendo.com/orgs/{orgId}/shipments \
  -H "Authorization: Bearer zipp_YOUR_TOKEN" \
  -H "Content-Type: application/json"

Korvaa {orgId} vaiheen 2 ID:llä. Token tarvitsee tähän kutsuun oikeuden read:shipments.

Älä koskaan laita API-tokeneita koodiin, joka ajetaan selaimessa tai mobiilisovelluksessa. Kutsu Zippendo-palvelua taustajärjestelmästäsi.

Haluatko tyypitetyn asiakasohjelman? Ilmaiset SDK:t TypeScriptille, Pythonille, PHP:lle, Golle ja Rubylle kattavat jokaisen rajapintakutsun, joten voit ohittaa raa’an HTTP:n.

Jokaisella paketilla on minuuttikohtainen pyyntöbudjetti. Katso Pyyntörajat.

4. Tutustu rajapintakutsuihin

Julkinen API kattaa seuraavat:

Alue	Tyypillinen käyttö
Lähetykset	Luo, lähetä, jaa ja seuraa lähetyksiä, hae osoitekortit ja asiakirjat
Tilaukset	Luo tilauksia ja lue myyntikanaviesi tuomat tilaukset
Myyntikanavat	Hallitse mukautettuja kanavia omalle verkkokaupallesi tai ERP:llesi
Kuljetusyhtiöt	Yhdistä kuljetusyhtiöitä, luettele niiden kuljetuspalvelut ja hae noutopisteitä
Toimituslaskelma	Toimitussääntöjesi mukaiset hinnat ostoskorille kassalla
Toimitussäännöt	Lue ja hallitse toimitussääntöjä
Webhookit	Saa ilmoitus, kun lähetykset, tilaukset ja seuranta muuttuvat
Osoitteet	Hallitse lähettäjän, noudon ja palautusten osoitteita

Avaa API reference selataksesi polkuja ja pyyntöjen sisältöjä ja kokeillaksesi pyyntöjä leikkikentässä.

Seuraavat vaiheet

Webhookien pikaopas

Lähetä tapahtumat palvelimellesi, kun tiedot muuttuvat.

Toimituslaskelmat

Näytä ostoskorin toimitushinnat kassalla.

MCP-palvelin

Anna Clauden, Cursorin tai ChatGPT:n työskennellä Zippendo-palvelussa puolestasi.

Mukautetut kanavat

Lähetä tilaukset omasta verkkokaupastasi tai ERP:stäsi Zippendo-palveluun.

Aloitus

Pika-aloitukset

Toimitusprosessi

Yhteydet

Toiminnot

Organisaatio ja tili

REST API:n pikaopas

1. Luo API-token

2. Hae organisaatiosi ID

3. Tee ensimmäinen pyyntö

4. Tutustu rajapintakutsuihin

Seuraavat vaiheet

Webhookien pikaopas

Toimituslaskelmat

MCP-palvelin

Mukautetut kanavat

​1. Luo API-token

​2. Hae organisaatiosi ID

​3. Tee ensimmäinen pyyntö

​4. Tutustu rajapintakutsuihin

​Seuraavat vaiheet

Webhookien pikaopas

Toimituslaskelmat

MCP-palvelin

Mukautetut kanavat

1. Luo API-token

2. Hae organisaatiosi ID

3. Tee ensimmäinen pyyntö

4. Tutustu rajapintakutsuihin

Seuraavat vaiheet