https://github.com/florianajir/kali-sku-server
Provide SKU management API server (powered by PHP)
https://github.com/florianajir/kali-sku-server
management php server sku
Last synced: about 1 month ago
JSON representation
Provide SKU management API server (powered by PHP)
- Host: GitHub
- URL: https://github.com/florianajir/kali-sku-server
- Owner: florianajir
- License: mit
- Created: 2015-09-08T08:34:55.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-01-15T09:32:05.000Z (over 10 years ago)
- Last Synced: 2025-12-28T11:24:36.907Z (6 months ago)
- Topics: management, php, server, sku
- Language: PHP
- Homepage:
- Size: 263 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kali-Server
Kali-Server provides a RESTful API centralizing SKU allocation and management for web-applications.
- [kali-client](https://github.com/1001Pharmacies/kali-client) The official *Symfony bundle* kali client
- [API doc](resources/doc/api/v1.0/index.md)
- [Commands](resources/doc/api/commands.md)
## Summary
- [Install](resources/doc/api/install.md)
- [Generate a Client](resources/doc/api/usage.md)
- [Root Endpoint](#root-endpoint)
- [HTTP Verbs](#http-verbs)
- [Authentication](#authentication)
- [Request token](#request-token)
- [Returned JSON](#returned-json)
- [Use token to fetch API](#request-token)
- [Request route](#request-route)
- [Headers parameters](#headers-parameters)
- [CLI example](#cli-example)
## Overview
## Root Endpoint
### API
```ShellSession
"https://{projectDomain}/api"
```
### API Doc
```ShellSession
"https://{projectDomain}/doc"
```
## HTTP Verbs
Where possible, API strives to use appropriate HTTP verbs for each action.
| Verb | Description |
| :------- | :------------------------------------ |
| GET | Used for retrieving sku resources. |
| POST | Used for creating sku resources. |
| PUT | Used for updating sku resources. |
| DELETE | Used for deleting sku resources. |
## Authentication
Kali server use a strict Oauth2 'client_credentials' authentication.
You have to generate a client to recieve a public and secret key to request a valid token to fetch the API.
This token expires after 1 hour by default, so you'll have to request another one.
### Request Token
```HTTP
GET https://{projectDomain}/oauth/v2/token?client_id={your public key}&client_secret={your secret key}&grant_type=client_credentials
```
#### Returned JSON
```JSON
{
"access_token": "{your access token}",
"expires_in": 3600,
"token_type": "bearer",
"scope": null
}
```
### Use Token to fetch API
#### Request Route
```HTTP
POST https://{projectDomain}/api
```
#### Headers parameters
| Name | Type | Description |
| :------------- | :----- | :-------------------------------------------- |
| Authorization | string | 'Bearer {the access token }' |
#### CLI example
```ShellSession
curl -H "Authorization: Bearer {access_token}" https://{projectDomain}/api
```