Console Core is a reselling platform used to resell various partner network services using a unified set of APIs (currently supported services are ports, layer 2 connections, and Internet exchange).

• Ethernet ports
• Ethernet connections
• Internet exchange

• Step 1. Get credentials and API key We have a production and demo/sandbox environments available. All testing should be done on the demo/sandbox environments. To get access to either of these environments contact your Account Executive.

• Step 2. Obtain an authentication token Use HTTP POST /partners/login endpoint with the credentials mentioned in the previous step, and it will return an authentication token.

• Step 3. Use the token and API key When using the API from a client code, set the token in the header authentication and x-api-key.

  ---

1. Here you can find API scenarios that explain how to use the APIs step by step.

   ---

Ports API scenarios

SCENARIO 1: Order a port

1. Query possible providers using the GET providers endpoint.
2. Query supported locations by provider key using the GET locations endpoint.
3. Query all port SKUs and select one using the GET ports by their SKUS endpoint.
4. Query prices by SKU ID and location key using the GET port prices endpoint.
5. Order a port using the POST ports endpoint with payload.

SCENARIO 2: Lookup a port

1. Query order status by order ID using the GET orders by order ID endpoint.
2. Get a port when order status is Pending or Completed using the GET ports endpoint.

   SCENARIO 3: Delete a port

1. Delete a port by ID using the DELETE a port endpoint.

2. Verify that the port is deleted using the GET port details endpoint.

Layer 2 connections API scenarios

SCENARIO 1: Order a layer 2 connection

1. Query source/destination ports by location and get VLAN IDs that are in use using the GET ports endpoint.

2. Query all layer 2 connection SKUs, using the GET layer 2 connections by their SKUS endpoint.

3. Query layer 2 connection prices by SKU ID, source location, and destination location using the GET layer 2 connection prices endpoint.

4. Order a layer 2 connection using the POST layer 2 connection endpoint.

SCENARIO 2: Lookup a layer 2 connection

1. Query layer 2 connection status by order ID using the GET orders by order ID endpoint.

2. Get a layer 2 connection when order status is Completed using the GET connections endpoint.

SCENARIO 3: Update a layer 2 connection

1. Check the valid bandwidth for the update using the Get available max bandwidth endpoint.

2. Request to update bandwidth using the POST update bandwidth endpoint.

3. Query layer 2 connection update using the GET orders by order ID endpoint.

SCENARIO 4: Delete a layer 2 connection

1. Delete a layer 2 connection by ID using the [DELETE connections by connection ID]#operation/deleteL2Connection) endpoint.

2. Verify that the layer 2 connection is deleted using the GET connection details endpoint.

Digital-Marketing

Partner-Network