Getting Started

The Xploite API allows you to create appications that can read/update information in your Xploite account.

Each request to the Api must be authenticated with your Api token using an "Authorization-Token" header containing your token.

For Example:

                        POST https://www.xploite.com/Api/Prospects
                        Authorization-Token: 6846a9d9eadc4c8bbeae5a1b672309d1
                        Content-Type: application/x-www-form-urlencoded
                    

When using the authentication token you do not require any additional password.

Important

You must treat your Api token as you would treat your login password. Anyone that has your Api token can post to the Api on your behalf! If you suspect someone has your Api token you can reset it via the "Setup > Api Tokens" menu link.

Organisations

Overview
URL https://www.xploite.com/Api/Organisations
Methods Supported POST, GET, PUT
Description Allows you to create, get and update organisations in an Xploite account
Elements For Organisations
OrganisationName required The name of the organisation (max length = 100)
AboutOrganisation About the organisation
DefaultCurrency The default currency of the organisation
IsSupplier Is the organisation a supplier (0 or 1)
GET Organisation

To get an Organisation, use the following URL where {guid} is the Guid of the Organisation:

                        GET https://www.xploite.com/Api/Organisations/{guid}
                    
Data Returned

When you GET an Organisation, the following JSON will be returned:

                        [
                            {
                                "Guid": "82591b61-d7ed-4c2a-99df-d83d3042ce04",
                                "OrganisationName": "Acme Industries",
                                "AboutOrganisation": "",
                                "DefaultCurrency": "GBP",
                                "IsSupplier": 0
                            }
                        ]
                    

When you POST a new Organisation, the api will return a JSON object with the Organisation's details.

                        POST https://www.xploite.com/Api/Organisations
                    

When you PUT (update) an Organisation, the api will return a JSON object with the Organisation's details.

                        PUT https://www.xploite.com/Api/Organisations/{guid}
                    

Errors returned are in the following format:

                        {
                            "Message": "Invalid authorization token"
                        }
                    

Prospects

Overview
URL https://www.xploite.com/Api/Prospects
Methods Supported POST, GET
Description Allows you to create, get and update prospects in an Xploite account
Elements For Prospects
FirstName The first name of the prospect (max length = 50)
LastName The last name of the prospect (max length = 50)
CompanyName The company name of the prospect (max length = 50)
Query required The prospect's query
Email required The email address of the prospect (max length = 50)
Phone The phone number of the prospect (max length = 50)
GET Prospect

To get a Prospect, use the following URL where {guid} is the Guid of the Prospect:

                        GET https://www.xploite.com/Api/Prospects/{guid}
                    
Data Returned

When you GET a Prospect, the following JSON will be returned:

                        [
                            {
                                "Guid": "23b3e31f-61a4-4741-915a-14f408884749",
                                "FirstName": "Jo",
                                "LastName": "Bloggs",
                                "CompanyName": "Bloggs Inc.",
                                "Query": "Please tell me how much your blue widgets cost",
                                "DateAdded": "2015-06-24T11:48:17.513",
                                "Email": "jo@bloggs.com",
                                "Phone": ""
                            }
                        ]
                    

When you POST a new Prospect, the api will return a JSON object with the Prospect's details.

                        POST https://www.xploite.com/Api/Prospects
                    

When you PUT (update) a Prospect, the api will return a JSON object with the Prospect's details.

                        PUT https://www.xploite.com/Api/Prospects/{guid}
                    

Errors returned are in the following format:

                        {
                            "Message": "Invalid authorization token"
                        }