Connecting Businesses to Customers
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3941890","collectionId":"8897e81a-4115-4209-bcc9-47311d0a5089","publishedId":"2s9YXh5hqQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-08T02:53:42.000Z"},"item":[{"name":"Getting Started","item":[{"name":"URL Structure","item":[],"id":"49702e8d-5628-4252-bd9c-541895564724","description":"The API URL structure depends on the type of request (whether GET or
POST) being made to our servers.
GET Requests: http://www.stamesoft.com/api/v1/list/{{id}}
Post Requests: http://www.stamesoft.com/api/v1/process
Before you can use the API you'll need to get your API key, which you use to
authenticate with the API. To access the API key for a Workspace 360,
1. You first need to log into your subscription account.
2. Go to account settings and then to integration settings.
3. Click on API integration to access the page..
4. Locate the API Key section and click on copy key.
The account ID can be accessed from the dropdown menu on the top
right hand side of the header which also contain user profile info and
navigation menu for a Workspace 360.
The department settings can be accessed from the manage
department page of the Workspace 360. To create, edit or delete
department:
1. You first need to log into your workspace 360 account as an
Administrator.
2. Go to settings menu and then click on manage departments.
3. On the manage department page, you would see a table of the
various department associated with that Workspace 360.
4. Copy the ID of the department you want from the ID section.
The Stames API is a web service that allows users to post or retrieve data on our servers from any website, software or mobile application. The API gives users all the supported functions of our service. The web service uses REST LIKE operations over HTTP POST AND GET requests with parameters URL encoded into the request and it’s response is encoded in JSON.
\nIt is designed to be easy to use and can be implemented in any model computer language that allows generating web requests. In order to use the Stames API, you must sign-up for an account, login and get your API Key from integration settings area.
\nAdditionally while developing your code it is advised to set API mode to TEST to generate some test requests. Using the Stames API or the Website indicates that you have read and accept the Terms & Conditions and the Privacy Policy. If you do not accept these terms, you are not authorized to use this service.
\n","_postman_id":"03350ec1-888d-4529-a6cb-f25d37ff3d1d"},{"name":"Using Stames API","item":[{"name":"Requirements","item":[],"id":"a0135f61-49b7-4591-b368-1abc51eabfad","description":"Before using Stames API to process or retrieve customer data or queries,
you must first make sure the API capability is enabled. This can be done
from General Settings tab under integration settings for subscription
accounts.
After making sure API is enabled, go to API Integration tab to choose whether your production environment would be LIVE or TEST.
\nWith your API Key & account ID in hand, you are ready to start using our API service.
\n","_postman_id":"a0135f61-49b7-4591-b368-1abc51eabfad"},{"name":"Supported API Functions","item":[],"id":"4d197d25-1061-409a-bbc4-dc3c13d37cc4","description":"Currently the Stames API is on 1.0 version and supports 3 functions
that are divided into 2 main parts: List API & Process API.
The List API accepts only GET requests and can retrieve all customer
data/tickets or specific data by passing a special identifier, IDD.
The Process API on the other hand accepts only POST requests.
\n","_postman_id":"4d197d25-1061-409a-bbc4-dc3c13d37cc4"},{"name":"Ticket List API","item":[{"name":"List Ticket API","id":"b3776a53-d589-4fa3-ba42-50c7136a5fcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.stamesoft.com/api/v1/list/tickets?aid=41735925&key=6800b045605b11eb807f00ffa60123ff","urlObject":{"protocol":"https","path":["api","v1","list","tickets"],"host":["www","stamesoft","com"],"query":[{"description":{"content":"Account ID (Required)
\n","type":"text/plain"},"key":"aid","value":"41735925"},{"description":{"content":"API Key (Required)
\n","type":"text/plain"},"key":"key","value":"6800b045605b11eb807f00ffa60123ff"}],"variable":[]}},"response":[],"_postman_id":"b3776a53-d589-4fa3-ba42-50c7136a5fcc"}],"id":"24bea00c-4b52-43dc-97db-1bbddf94c39e","description":"The Tickets List API function processes requests with active API Key, account ID and required or optional parameters and returns a list of all tickets or specific tickets from a Workspace 360. For the API function to return a specific ticket or tickets, request must contain a unique IDD.
\nHTTP Method: GET API URL:https://www.stamesoft.com/api/v1/list/tickets
Account ID (Required)
\n","type":"text/plain"},"key":"aid","value":"41735925"},{"description":{"content":"API Key (Required)
\n","type":"text/plain"},"key":"key","value":"6800b045605b11eb807f00ffa60123ff"},{"description":{"content":"Ticket ID (Required)
\n","type":"text/plain"},"key":"tid","value":"1407"}],"variable":[]}},"response":[],"_postman_id":"f1f96e6f-134e-4c40-91e2-79e7be40525c"}],"id":"ad5458c3-ef50-4473-87f3-87e97efc9468","description":"The Messages List API function processes requests with active API Key, account ID & ticket ID and returns a list of all messages for the specified ticket ID associated to the Workspace 360.
\nHTTP Method: GET API URL:https://www.stamesoft.com/api/v1/list/messages
Account ID (Required)
\n"},{"key":"key","value":"6800b045605b11eb807f00ffa60123ff","type":"text","description":"API Key (Required)
\n"},{"key":"fname","value":"Robert","type":"text","description":"First Name (Required)
\n"},{"key":"lname","value":"William","type":"text","description":"Last Name (Required)
\n"},{"key":"email","value":"user@example.com","type":"text","description":"Email Address (Required)
\n"},{"key":"phone","value":"+233244792375","type":"text","description":"Phone Number (Required)
\n"},{"key":"department","value":"281","type":"text","description":"Department ID (Required)
\n"},{"key":"priority","value":"4","type":"text","description":"Priority ID (Required)
\n"},{"key":"subject","value":"API test","type":"text","description":"Subject (Required)
\n"},{"key":"message","value":"Just testing the api","type":"text","description":"Message Payload (Required)
\n"},{"key":"user","value":"Client","type":"text","description":"User Type accepts only Admin, Client or Staff (Required)
\n"},{"key":"idd","value":"1221","type":"text","description":"Special Identifier (Optional)
\n"}]},"url":"http://www.stamesoft.com/api/v1/process/","urlObject":{"protocol":"http","path":["api","v1","process",""],"host":["www","stamesoft","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebd03d0b-52f1-40c8-9083-ca8e8b168706"}],"id":"bb411e9e-564f-4028-998e-549d0f5080cd","description":"The Process API function processes requests with active API Key, account ID and required or optional parameters. This API function is used to create new requests and pass valuable data that can be accessed using Workspace 360.
\nHTTP Method: POST API URL:https://www.stamesoft.com/api/v1/process/
The priority ID request parameter indicate the priority level of the request
being processed.
1 - Low
2 - Medium
3 - High
4 - Urgent
5 - Emergency
6 - Critical
There are 3 values that can be passed as a user parameter namely: Admin, Staff
and Client. If the request author is a client, then pass Client as the value for
user parameter. Likewise if the author is an admin or staff, the value then
becomes Admin or Staff.
Our API allows you to build your own intelligent applications within minutes. There are no limitations on what type of applications that you can build (web services, mobile apps, windows apps etc). All you have to do is to call our service when you need to retrieve or process customer requests & data to a specific Workspace 360.
\n","_postman_id":"3390965c-fa68-422e-ae43-ce0912a17a99"},{"name":"Response Codes","item":[],"id":"4793f3b3-aae5-4cf6-bf35-59f73d7259e0","description":"These response codes provide a more detailed description of any problems
which may have occurred with an API call including incorrect parameters or
actions which violate the business logic of the system, such as illegal state
changes, invalid amounts or dates, and so forth.
100 - Request submitted successfully
101 - Something horribly went wrong. Please contact support.
103 - We couldn't match a user type or one or more parameters. Check our developer documentation for more info.
105 - Looks like department ID or priority ID or both do not match. Please refer
to our developer documentation for more info.
106 - No data is connected to the specified Ticket ID. Please try again with the
correct ticket ID.
107 - API is not enabled for the module specified. Please log into your
subscription account and activate api.
109 - The specified key or account ID do not match any account in our database.
111 - Subscription has expired. Please renew subscriptions to perform this action.
113 - API Key is not valid. Please go to integration settings to access your
api key.
121 - Invalid request parameter submitted. Please check your api url and send request again.
200 - Request successfully processed.
\n201 - No data available under the module specified.
\n","_postman_id":"4793f3b3-aae5-4cf6-bf35-59f73d7259e0"}],"variable":[{"key":"AccountID","value":"41735925"},{"key":"APIKey","value":"6800b045605b11eb807f00ffa60123ff"},{"key":"TicketID","value":"1407"},{"key":"First Name","value":"Gideon"},{"key":"Last Name","value":"Williams"},{"key":"Email Address","value":"demo@example.com"},{"key":"Phone Number","value":"+233249046373"},{"key":"Department ID","value":"98"},{"key":"FirstName","value":"Robert"},{"key":"LastName","value":"William"},{"key":"EmailAddress","value":"user@example.com"},{"key":"PhoneNumber","value":"+233244792375"},{"key":"DepartmentID","value":"281"},{"key":"PriorityID","value":"4"},{"key":"Subject","value":"API test"},{"key":"Message","value":"Just testing the api"},{"key":"UserType","value":"Client"},{"key":"IDD","value":"1221"},{"key":"Accountid","value":"{{56388100}}"}]}