Issue API


The Issue API lets you look up and register issues in the industries for b2b, based on a company domain, department type, keyword or similar issue. For example, you could retrieve a list of issues for a specific company. Or you could register an issue for your department, let say Research & Development.
Note: The issue API is on Open source and so is free of charge. 


 

 

registerAnIssue


HTTP REQUEST


GET https://map.arkanna.co/_functions/issue/register?title=<title>

(Where :<title> is the issue’s title)

HTTP GET PARAMS


Alongside the title you may also provide any additional attributes you have about the issue, such as their description, email of the owner. Including more detail will help us be more accurate when searching.

The supported parameters are:


email    : string (required) - The email address of the personne registering the issue
title    : string (required) - The title of the issue
description    : string (required) - The description of the issue
departmentTargeted : string (required) - The department concerned by the issue
listOfDomains : string (required) - The companies concerned by the issue. Note that the list of domain is required as domain is unique and so more accurate than the company name. You can list them separated by ","   site1.com,site2.com,site3.com... The more domains are listed, the more chance it has to be matched with a solution. 
followers : string - List of emails following the issue and wanted to be alerted when a solution is found. email1, email2, email3 ...
hashtags : string - List of hashtags categorizing the issue.  keyword1, keyword2, keyword3 ...


RESPONSE TYPES


Code    Description
001    Issue recorded successfully.
002    Error elements missing, issue not registered.

 

 

searchIssues


HTTP REQUEST


GET https://map.arkanna.co/_functions/issue/search?title=<title>

(Where :<title> is the issue’s title)

HTTP GET PARAMS


Alongside the title you may also provide any additional attributes you have about the issue, such as their company domain, keyword. Including more detail will help us be more accurate when searching. At least one parameter needs to provided for a valide call. 

The supported parameters are:


title    : string - The title of the issue
departmentTargeted : string - The department concerned by the issue
domain : string -  Domain is unique and so more accurate than the company name.  The issues link to the domain will be listed.
hashtag : string - One keyword that needs to be in the issue. 


RESPONSE TYPES


Code    Description
001    Successful lookup, issues encoded in the response body.
002    No issue were found.


 

 

subscribeAnIssue 

HTTP REQUEST


GET https://map.arkanna.co/_functions/issue/subscribe?title=<title>

(Where :<title> is the issue’s title)

HTTP GET PARAMS


Alongside the title you may also provide any additional attributes you have about the issue, such as their company domain, keyword. Including more detail will help us be more accurate when searching. At least one parameter needs to provided for a valide call. 

The supported parameters are:


title    : string - The title of the issue
departmentTargeted : string - The department concerned by the issue
domain : string -  Domain is unique and so more accurate than the company name.  The issues link to the domain will be listed.
hashtag : string - One keyword that needs to be in the issue. 


RESPONSE TYPES


Code    Description
001    successfully subscribed to  <number of issues> issues
002    No issue were found.

 

 

 

Solution API


 

 

registerSolution


HTTP REQUEST


GET https://map.arkanna.co/_functions/solution/register?title=<title>

(Where :<title> is the solution’s title)

HTTP GET PARAMS


Alongside the title you may also provide any additional attributes you have about the issue, such as their company domain, keyword. Including more detail will help us be more accurate when searching. At least one parameter needs to provided for a valide call. 

The supported parameters are:


authentification : string (required) - your private key. Register to map.arkanna.co to gett your key. (You can ask for an invitation at partner@arkanna.co)
title    : string (required) - The title of the solution
videoURL    : string (required) - The youtube url of presentation (1minute video of presentation)
whatIsIt    : string (required) - Describe what the solution is doing
whyIsItImportant : string (required) - Describe the impact that it will have for the end client. :
powerpointURL    : string (required) - The url pointing to the powerpoint presentation of the solution.
howToSell    : string (required) - The process required to sell it.
emailForTrial : To who the request of trials needs to be sent to try the solution ?
departmentTargeted : string (required)  - The department concerned by the issue
listOfDomains : string (required) - The companies concerned by the solution. Note that the list of domain is required as domain is unique and so more accurate than the company name. You can list them separated by ","   site1.com,site2.com,site3.com... The more domains are listed, the more chance it has to be matched with an issue from the industry. 
hashtags : string - List of hashtags categorizing the issue.  keyword1, keyword2, keyword3 ...
issueTitle : string (required)   - The solution needs to be attached to an existing issue. The title is used to identify the issue. 
unitPrice : string (required)   - The price of one unit.
type : string - The type of solution (Technology License, Product, Service, Software or Training)  


RESPONSE TYPES
Code    Description
001    successfully registered
002    Not successful, issues with the inputs

 

 

searchSolutions  


HTTP REQUEST


GET https://map.arkanna.co/_functions/solution/search?title=<title>

(Where :<title> is the solution’s title)

HTTP GET PARAMS


Alongside the title you may also provide any additional attributes you have about the issue, such as their company domain, keyword. Including more detail will help us be more accurate when searching. At least one parameter needs to provided for a valide call. 

The supported parameters are:


authentification : string (required) - your private key. Register to map.arkanna.co to gett your key. (You can ask for an invitation at partner@arkanna.co)
title    : string - Return the solution with the exact title
departmentTargeted : string - List all the solutions targeting this department
domain : string -  Domain is unique and so more accurate than the company name.  Return a list of solutions targeting the company domain.
hashtag : string - Filter with one keyword
issueTitle : string - Return the list of solutions answering the issue.
limit : number - Limit the number of results up to this number.

RESPONSE TYPES
Code    Description
001    successfully registered
002    Not successful, issues with the inputs

 
 
 
 
 

Contactez nous

Besoin de nous contacter pour obtenir un accès à nos outils ? Pour plus de précision sur notre méthodologie ? N’hésitez pas.

©2019 Arkanna 

Notre Société

Social

ic-linkedin.png