Theme

CSP Services ​

API endpoints for CSP Services management in WORKSPACE.

Setup a CSP ​

http
POST /v1/:wid/csp/setup

Register & manage the platform. Eg. e-commerce application.

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Setup a CSPRequest {
  type: string;
  name: string;
  description: string;
  logo: string;
  contacts: {
    emails: string[];
    phones: string[]
  };
  address: {
    name: string;
    street1: string;
    city: string;
    state: string;
    country: string;
    coordinates: number[]
  };
}

Example:

json
{
  "type": "VENDOR",
  "name": "Mlò",
  "description": "Best restauration shop in Africa",
  "logo": "https://pixels.con/304x399/pictusor-medata",
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "+228 90 49 43 43",
      "+233 204 55323"
    ]
  },
  "address": {
    "name": "Manoa Susu",
    "street1": "3rd Road, MSBSI Schook, Mamprobi",
    "city": "Accra",
    "state": "Greater Accra",
    "country": "Ghana",
    "coordinates": [
      -0.3387423,
      5.4284859
    ]
  }
}

Get a CSP ​

http
GET /v1/:wid/csp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get All CSPs ​

http
GET /v1/:wid/csps

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request CSP Context ​

http
GET /v1/:wid/csp/:xcode/context

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update a CSP ​

http
PATCH /v1/:wid/csp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Delete a CSP ​

http
DELETE /v1/:wid/csp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)