Skip to content

Semify Enterprise REST APIs (2.0.0)

This is the documentation for the Semify Endpoints based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io.

Find more info here
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.semify.com

API Support

developers@semify.com

License

Apache 2.0

Languages
Servers
Mock server

https://developers.semify.com/_mock/openapi/

Sandbox

https://uat.services.semify.com/

Production Server

https://services.semify.com/

accounts

Operations related to accounts.

Operations

keywords

Operations related to keywords.

Operations

reports

Reporting endpoints.

Operations

products

Product management endpoints.

Operations

Create and attach a service / product plan

Request

This endpoint attaches a product plan to an account.

Security
JWTAuth
Bodyapplication/jsonrequired

Needed fields to attach a product plan to an account.

account_idinteger

Please enter an account id.

Example: 12345
campaign_idinteger

Please enter a campaign id.

Example: 54321
service_plan_idinteger

Please enter a service plan id.

Example: 2100
curl -i -X POST \
  https://developers.semify.com/_mock/openapi/api/v1/products/plans/campaigns \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_id": 12345,
    "campaign_id": 54321,
    "service_plan_id": 2100
  }'

Responses

200 OK

Bodyapplication/json
dataobjectrequired
Example: {"account_id":12345,"campaign_id":54321,"service_plan_id":2100}
data.​account_idinteger(int64)
Example: 12345
data.​campaign_idinteger(int64)
Example: 54321
data.​service_plan_idinteger(int64)
Example: 2100
errorbooleanrequired
Example: false
paginationobjectrequired
Example: {"totalPages":1,"maxRows":0,"offset":0,"page":1,"totalRecords":1}
pagination.​totalPagesinteger(int64)
Example: 1
pagination.​maxRowsinteger(int64)
Example: 0
pagination.​offsetinteger(int64)
Example: 0
pagination.​pageinteger(int64)
Example: 1
pagination.​totalRecordsinteger(int64)
Example: 1
messagesArray of stringsrequired
Example: ["Successful plan attachment"]
Response
application/json
{
  "data": {
    "account_id": 12345,
    "campaign_id": 54321,
    "service_plan_id": 2100
  },
  "error": false,
  "pagination": {
    "totalPages": 1,
    "maxRows": 0,
    "offset": 0,
    "page": 1,
    "totalRecords": 1
  },
  "messages": [
    "Successful plan attachment"
  ]
}

Get service plans for campaign and account

Request

Returns available service plans for a given campaign and account.

Security
JWTAuth
Path
campaign_idintegerrequired

Numeric ID of the campaign to retrieve service plans for.

Example: 26939
account_idintegerrequired

Numeric ID of the account to retrieve service plans for.

Example: 1
curl -i -X GET \
  https://developers.semify.com/_mock/openapi/api/v1/products/plans/campaigns/26939/accounts/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of available service plans.

Bodyapplication/json
dataArray of objects
messagesArray of strings
Example: ["Service plan retreival success"]
paginationobject
errorboolean
Example: false
Response
application/json
{
  "data": [
    { … },
    { … }
  ],
  "messages": [
    "Service plan retreival success"
  ],
  "pagination": {
    "maxRows": 0,
    "totalPages": 1,
    "offset": 0,
    "page": 1,
    "totalRecords": 3
  },
  "error": false
}

authentication

Authentication/authorization endpoints.

Operations

campaigns

Campaigns and related operations.

Operations

google gbp accounts

Google GBP account endpoints.

Operations