NAV -image
bash javascript php

Introduction

Dokumentasi ini bertujuan untuk memberikan semua informasi yang Anda butuhkan untuk bekerja dengan API kami.

Base URL

http://erunix-driver-api.test

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Anda bisa mendapatkan token Anda dengan cara Login.

Authentication

API endpoints for managing authentication

Masuk dengan kredensial.

Pengguna hanyal boleh memiliki 1 token akses.

Example request:

curl -X POST \
    "http://erunix-driver-api.test/api/login" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{"username":"aryaanggara.dev@gmail.com","password":"isipassword"}'

const url = new URL(
    "http://erunix-driver-api.test/api/login"
);

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
};

let body = {
    "username": "aryaanggara.dev@gmail.com",
    "password": "isipassword"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://erunix-driver-api.test/api/login',
    [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'json' => [
            'username' => 'aryaanggara.dev@gmail.com',
            'password' => 'isipassword',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/login

Body Parameters

username  string  
username pengguna.

password  string  
kata sandi pengguna.

Fetch user.

requires authentication

Example request:

curl -X POST \
    "http://erunix-driver-api.test/api/fetch" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/fetch"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://erunix-driver-api.test/api/fetch',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

POST api/fetch

Logout

requires authentication

Example request:

curl -X DELETE \
    "http://erunix-driver-api.test/api/logout" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/logout"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'http://erunix-driver-api.test/api/logout',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
 "message": "Token dihapus!",
}

Request      

DELETE api/logout

Driver Notification

Mendapatkan list data Notifikasi Saya.

requires authentication

Dibagian ini Anda bisa mendapatkan list data Notifikasi Saya.

Example request:

curl -X GET \
    -G "http://erunix-driver-api.test/api/driver-notifications?search=...&page[number]=1&page[size]=2&sort=created_at" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/driver-notifications"
);

let params = {
    "search": "...",
    "page[number]": "1",
    "page[size]": "2",
    "sort": "created_at",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://erunix-driver-api.test/api/driver-notifications',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'search'=> '...',
            'page[number]'=> '1',
            'page[size]'=> '2',
            'sort'=> 'created_at',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

GET api/driver-notifications

Query Parameters

search  string optional  
Mencari data Notifikasi Saya.

page[number]  string optional  
Menyesuaikan URI paginator.

page[size]  string optional  
Menyesuaikan jumlah data yang ditampilkan.

sort  string optional  
Menyortir data ( key_name / -key_name ), default -created_at.

Firebase

Memperbaharui device token.

requires authentication

Example request:

curl -X POST \
    "http://erunix-driver-api.test/api/firebase/device-token" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{"device_token":"cSN1fH..."}'

const url = new URL(
    "http://erunix-driver-api.test/api/firebase/device-token"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
    "Content-Type": "application/json",
};

let body = {
    "device_token": "cSN1fH..."
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://erunix-driver-api.test/api/firebase/device-token',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'json' => [
            'device_token' => 'cSN1fH...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
 "message": "Berhasil memperbaharui device token.",
}

Request      

POST api/firebase/device-token

Body Parameters

device_token  string  
device token.

Order Saya

Memperbaharui Trafic Monitoring.

requires authentication

Example request:

curl -X POST \
    "http://erunix-driver-api.test/api/orders/tm/1" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{"image":"path...","note":"...","location":"31.2467601,29.9020376"}'

const url = new URL(
    "http://erunix-driver-api.test/api/orders/tm/1"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
    "Content-Type": "application/json",
};

let body = {
    "image": "path...",
    "note": "...",
    "location": "31.2467601,29.9020376"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://erunix-driver-api.test/api/orders/tm/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'json' => [
            'image' => 'path...',
            'note' => '...',
            'location' => '31.2467601,29.9020376',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

POST api/orders/tm/{traffic_monitoring}

URL Parameters

traffic_monitoring  integer  
valid id traffic_monitoring. Defaults to 'id'.

Body Parameters

image  string optional  
gambar.

note  string  
catatan.

location  string optional  
lokasi (lat, long).

Mendapatkan list data Order Saya.

requires authentication

Dibagian ini Anda bisa mendapatkan list data Order Saya.

Example request:

curl -X GET \
    -G "http://erunix-driver-api.test/api/my-orders?search=...&done=...&page[number]=1&page[size]=2&sort=created_at" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/my-orders"
);

let params = {
    "search": "...",
    "done": "...",
    "page[number]": "1",
    "page[size]": "2",
    "sort": "created_at",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://erunix-driver-api.test/api/my-orders',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'search'=> '...',
            'done'=> '...',
            'page[number]'=> '1',
            'page[size]'=> '2',
            'sort'=> 'created_at',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

GET api/my-orders

Query Parameters

search  string optional  
Mencari data Order Saya.

done  string optional  
filter berdasarkan order selesai (options : true, false).

page[number]  string optional  
Menyesuaikan URI paginator.

page[size]  string optional  
Menyesuaikan jumlah data yang ditampilkan.

sort  string optional  
Menyortir data ( key_name / -key_name ), default -created_at.

Mendapatkan Detail Order.

requires authentication

Example request:

curl -X GET \
    -G "http://erunix-driver-api.test/api/my-orders/1" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/my-orders/1"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://erunix-driver-api.test/api/my-orders/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

GET api/my-orders/{manifest}

URL Parameters

manifest  integer  
valid id manifest. Defaults to 'id'.

Mendapatkan timewindows.

requires authentication

Example request:

curl -X GET \
    -G "http://erunix-driver-api.test/api/my-orders/timewindows/1" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/my-orders/timewindows/1"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://erunix-driver-api.test/api/my-orders/timewindows/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "message": "Unauthenticated."
}

Request      

GET api/my-orders/timewindows/{manifest}

URL Parameters

manifest  integer  
valid id manifest. Defaults to 'id'.

Server

Ping the server.

Example request:

curl -X GET \
    -G "http://erunix-driver-api.test/api/ping" \
    -H "Accept: application/json"
const url = new URL(
    "http://erunix-driver-api.test/api/ping"
);

let headers = {
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://erunix-driver-api.test/api/ping',
    [
        'headers' => [
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

{
    "status": "ok",
    "timestamp": "2022-08-17T17:11:13.472126Z",
    "host": "127.0.0.1"
}

Request      

GET api/ping

bash javascript php