TheSpiritProject REST API

Overview

This API's are used to provide the data to inbound project from one domain to another domain. You can test the API with given environment (Production). All the api request start with http://beta.core.thespiritproject.com/api/XXX---XXX*

Note : XXX replaces with API name.



Authenticate

You must use your domian-key, api_key, api_secret for that method.

You'll get your domian-key, api_key, api_secret by API owner so contact to API owner according to your Domain name and Organization.

When you will use Authenticate API it will always return an encrypted authentication token back for use on subsequent calls.

That token remains valid only for next 1 hour after generating for user of other subsequent calls.


Implementation

Method: POST

URI: /authenticatie

Authentication: Require a valid domian-key,api_key and secret key to use this API

*Required HEADER
Parameters Type Description
domain-key String This accedomainss-key required to use this API. You can get this domain-key from API owner.
api_key String This api_key required to use this API. You can get this api_key from API owner.
api_secret String This api_secret required to use this API. You can get this api_secret from API owner.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
username* Integer This is email you enters for login into dashboard.
password* Integer This is password for login into dashboard.

Production

               
curl "http://beta.core.thespiritproject.com/api/authenticate" \
domian-key: Your domian key according to your domain
api_key: Your api key according to your Organization
api_secret: Your api secret according to your Organization


Authentication Response

TheSpiritProject API returns data in JSON format. Example authenticate return the user details with token in this format:

Response

{"status":"1","message":"Success","result":{"agency_id":123,"id":1234,"user_type":"1,2","org_roles":0,"time_zone":"America\/Los_Angeles","manual_organisation":"0","first_name":"Test","last_name":"Test","user_roles":[0,5],"account":"{\"details\":{\"id\":4057,\"client_id\":1,\"person_id\":null,\"email\":\"Test@mailinator.com\",\"username\":\"\",\"password\":\"XXXXXXXX",\"first_name\":\"ABC\",\"last_name\":\"XYZ\",\"logins\":0,\"unique_id\":\"0\",\"manual_organisation\":\"0\",\"created_user\":\"0\",\"patternId\":\"0\",\"stActive\":\"0\",\"last_login\":null,\"license_agreed_date\":\"0000-00-00 00:00:00\",\"recover_token\":null,\"recover_date\":null,\"created_at\":\"2017-06-16 14:25:11\",\"updated_at\":\"2017-08-03 10:48:30\",\"removed_flag\":0,\"removed_by\":0,\"profilephoto\":\"\",\"user_type\":\"1,2\",\"time_zone\":\"America\\\/Los_Angeles\",\"org_roles\":0,\"failed\":0,\"failedlasttime\":\"1501760098\",\"notificationsfor\":\"1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19\",\"notificationsforproviders\":null,\"isAdmin\":0,\"contact_number\":\"\",\"domain\":1,\"relationship_status\":1,\"time_timezone\":\"UTC\"}}"},"token":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}