Kirjaudu sisään

Ship Help Center

Client ID:n ja Client Secretin luominen Ship API v2:lle

Avatar
Malene Tidemann
Päivitetty

Ship API:n käyttö edellyttää tunnisteiden (Client ID ja Client Secret) käyttöä. Tässä artikkelissa kerrotaan, miten ne luodaan. 


Huomaa, että vain "owner"- ja "admin"-käyttäjillä on pääsy API Configuration -sivulle. On suositeltavaa luoda erillinen admin-käyttäjä API-käyttöä varten. Tärkeää: jos käyttäjä, joka loi tunnistetiedot, poistetaan, tunnistetiedot lakkaavat toimimasta.


 

Client ID:n ja Client Secretin luominen

  1. Kirjaudu sisään nShift Portal -palveluun owner-käyttäjälläsi.
     
  2. Valitse vasemmasta valikosta Settings > API Configuration > Clients.

    clients.png
     
  3. Napsauta Clients-sivulla painiketta Add.

    add-clients-api.png
     
  4. Täytä valintaikkunassa kentät Display name ja Description. Valitse nimi ja kuvaus, joiden avulla Client ID on helppo tunnistaa myöhemmin. Valitse Enabled aktivoidaksesi sen heti. (Voit ottaa tunnuksen käyttöön tai poistaa sen käytöstä myöhemmin.)

    clientID-API.png
     
  5. Valitse Shipment Server (public_api_shipmentserver) kohdassa Allowed Scopes. Allowed scopes ovat API:t, joihin tarvitset pääsyn.
     
  6. Napsauta Save. Client Id ja Client Secret luodaan ja näytetään nyt näytöllä. 
    Tärkeää: Kirjoita muistiin Client ID ja Client Secret. Client Secret ei ole enää saatavilla, kun suljet ponnahdusikkunan.

    client-secret-API.png
     
  7. Kun suljet ponnahdusikkunan, Client ID näkyy Clients-sivulla. Voit milloin tahansa klikata Client ID:tä muokataksesi tai poistaaksesi sen tai ottaaksesi sen käyttöön/pois käytöstä. Jos sinulla on pitkä lista ID:itä, voit käyttää yläreunan suodatinta näyttääksesi vain käytössä olevat tai poistetut tunnukset.

     

Käyttöoikeustokenin hakeminen

Käytä Client ID:tä ja Client Secretia luodaksesi käyttöoikeustokenin, jota tarvitaan Ship API V2 -kutsuihin. Tämä tehdään lähettämällä POST-pyyntö seuraavaan token-endpointiin:

https://account.nshiftportal.com/idp/connect/token 

Määritä Client ID, Client Secret ja grant type yrityksesi käyttämässä kielessä ja kehyksessä.


Esimerkki:
POST https://account.nshiftportal.com/idp/connect/token
Cache-Control: no-cache
Host: www.nshiftportal.com 
Content-Type: application/x-www-form-urlencoded

client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials

 

Jos pyyntö on kelvollinen ja client on määritetty oikein, saat JSON-vastauksen:

{ "access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsoidfgvoiltgjvpdrofjmwpkldujrftvoifgkhbnilsakjprotglijkqp2owrlfjkvmowrifgho2qw9ouejifpe9rodtuj3-0porfij9odtujgw0etioyh", "expires_in": 3600, "token_type": "Bearer" "scope": "public_api_shipmentserver" }

 

Katso artikkeli: How to - Authenticate

Aiheeseen liittyvät artikkelit