How to Create a New Connector in Precog

If you don’t see the connector you need, Precog can create a new one for you.

Providing Precog with the complete information is crucial for creating a new connector. The more information you provide to Precog, the easier and faster it will be to create a new connector.

1. Log in to your Precog account.
2. Add a new data pipeline and search for a connector.
3. Click on the “Create new connector” button located below the search bar. This will open the “Create new connector” wizard. There are six steps to be completed.

Create new connector steps

1. Enter the name of the software product that you want to create a connector for. Please use the most recognized name and avoid abbreviations.
   
   
2. As you gather information for the connector, it is important to understand that Precog connects to data sources via a Web API. This API may be referred to as REST, SOAP, OData, GraphQL, or as a Web Service.
   
   
3. Enter the homepage URL and the login URL. The homepage URL contains marketing or general information about the software you are trying to connect to. The login URL helps Precog identify any hosting and geographical considerations for this connector. The URLs need to be in a valid format, so include the “https://”.
   
   
4. You will then be asked to provide a use case for data from this connector. Having a firm understanding of the use case for your data is fundamental. Precog requires a use case prompt for solving a business problem in order to create the connector.
   
   The connector will not be limited by your use case, and you can provide additional use cases in the future.
   
   Example use case prompts:
   
   - I need to reconcile damaged products and returns with my inventory.
   
   - We need lifetime product value based on marketing costs, orders, returns and fulfillment costs.
   
   - I need to increase the retention rate of my placed candidates.
   
   - We want to rank our staff by how quickly and accurately they process purchase orders and requisitions.
   
   

   You can also provide any tables or datasets would you like to access with this connector. This is not mandatory, but it can be helpful when a large number of datasets are available through an API.
   
   

5. Provide API or developer documentation containing the details of how to connect to the software product you want to connect to. You can find your API documentation by searching in the help sections of your software or by searching the internet using the search term “API documentation”. If the documentation is not publicly accessible, then export and upload the documentation as a PDF, OpenAPI, or Swagger document (JSON or YAML).
   
   
6. Precog will need your credentials to access the API. Types of credentials differ from one API to the next. Check the API documentation to find out what type of credentials are required and what steps you will need to complete to attain those credentials.
   You may need to create an “application” to connect you to your data but this does not require you to develop or code an application but rather refers to creating the credentials required to access the API. We advise that you name any applications “precog” so it will be clear what the credentials are being used for in the future.
   
   Valid API credentials can include username and password, a client ID and secret or a token. For example, Client ID: 292085223830.apps.erp-software.com and Client Secret: GGCTtn9gVHW4li2ohitH8FvS-67 or Username: admin@precog.com and Password: 123XYZ!. If you have certificates, keys, or any other type of credential files necessary for accessing the API, then upload them to Precog.
   
   Click on the “Create connector” button to submit your connector. Precog will begin working on your new connector right away. You will be notified when the new connector is ready or if other information or action is required.