Skip to content

Vigo API Dokümantasyonu

Bu dökümantasyon, Vigo API sürümüne ait endpointleri ve entegrasyon detaylarını içermektedir. API, sipariş yönetimi ve sistemler arası veri entegrasyonu gibi işlevler için kullanılabilir.

İletişim

Başvuru ve sorularınız için integration@vigo.ist adresine mail iletebilirsiniz.

Download OpenAPI description
docs.json
docs.yaml
Overview
Vigo Integration Support

integration@vigo.ist

Languages
Servers
Mock server

https://developers.vigo.ist/_mock/docs/

Development server

https://app-dev.vigo.ist/api/v2/

Production server

https://app.vigo.ist/api/v2/

Kimlik Doğrulama

Kimlik ve Yetkilendirme ile ilgili işlemleri içermektedir.

API'yi kullanabilmek için bir erişim token'ı alınmalıdır. Hesabınız oluşturulduğunda size özel clientId ve clientSecret bilgileri e-posta yoluyla iletilir. Bu bilgiler kullanılarak token alınması gerekmektedir.
Token alındıktan sonra, tüm yetkili isteklerde header bilgisi içinde x-auth-token key'i ile iletilmelidir.

Operations

Token Alma

Request

Vigo API endpointlerine istek atabilmek için gerekli olan token'ı bu endpoint üzerinden alabilir.

Bodyapplication/jsonrequired
clientIdstringrequired

Api kullanıcısının kimliği

clientSecretstringrequired

Api kullanıcısının gizli anahtarı

curl -i -X POST \
  https://developers.vigo.ist/_mock/docs/auth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "string",
    "clientSecret": "string"
  }'

Responses

Token başarılı bir şekilde yaratıldı.

Bodyapplication/json
tokenstring

Anahtar bilgisi

expiresAtinteger

Timestamp formatında token geçerliliğinin sonlanma zaman bilgisi

Response
application/json
{
  "token": "string",
  "expiresAt": 0
}

Sipariş

Sipariş ile ilgili işlemleri içermektedir. Sipariş için gerekli olan statü güncelleme işlemleri için bu endpointleri inceleyebilirsiniz.

Operations

Alım Noktası

Siparişlerin kurye tarafından alınacağı noktayı ifade eder

Mevcut pickUp onboardingStatus (alım noktası durumları) değerleri:

  • candidate (Aday)
  • approved (Onaylandı)
  • rejected (Reddedildi)
  • pending (Belge Onay Bekliyor)
Operations

Sipariş Geri Bildirimleri

Tarafınıza iletilen callback örnekleri içermektedir.

Operations