​

Extra information

System documentation: [Copper API Reference]

​

Setting up HTTP Client Copper

​

Steps

• In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Copper HTTP Client as the prototype of the HTTP Client.
• Fill in the Base URI, Authentication type.
  • Oauth2.0 : Fill the Client ID, Client Secret, and Scopes. (Authorize | Access Token URL is optional), Grant Access to Copper.
  • Api Keys : Fill in X-PW-AccessToken, X-PW-Application, and X-PW-UserEmail.
• Save the Client for use later.

​

Subscribing to Entities from Copper

​

Steps

• Go to Connections -> Incoming and create a new incoming configuration and select Copper Subscriber as the subscriber.
• Select the entity you want to subscribe from Copper .
• Add any request parameters needed to subscribe to the entity (optional).
• You can optionally add a transformer to transform the request parameters into something you need.
• Select the Copper HTTP Client to use.

​

General Concept

We follow Copper documentation on building this connector so you can easily use the connector based on Copper API Reference. Method It’s the Method you want to subscribe from Copper. Based on the Method, the Entity will change. Entity It’s the entity you want to subscribe from Copper . Please refer to the entities in Management APIs from Copper API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on Copper API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing See a Persons Activities. That’s why we need to define the example_person_id property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on See a Persons Activities. /developer_api/v1/people/123321/activities Input Transformer Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration or prototype you will use to access Copper .

​

Publishing Entity to Copper

​

Steps

• Go to Connections -> Outgoing, create a new outgoing configuration, and select Copper Publisher as the publisher.
• Select the action that you want the publisher to do with the data.
• Select the Copper entity you want the data to be published.
• You can optionally add any query parameters to the request.
• You can also optionally add any transformers to transform the data into anything you need before submitting it to Copper .
• Select the HTTP Client to use.

​

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. Method Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). Entity We support publishing to most Copper endpoints. Please refer to the entities in Management APIs from the Copper API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a New Company. Please select “Post” as the action and “Create a New Company” as the entity of the publisher. You can put the payload you want to send to Copper into the payload property in the data. Alumio will send an API request to Copper with URL /developer_api/v1/companies HTTP Client It’s the HTTP Client configuration or prototype you will use to access Copper .