In one embodiment, the connectivity coordinator may provide a “Getting Started Guide” or some other similar documentation that may provide examples of how the interface may be used. The following list, with entries labeled API-1 through API-18, is a set of API call invocation examples that may be provided in such documentation for a subset of connectivity services provided by connectivity coordinator 114.
[API-1] CustomerId customerId=createNewCustomer(CustomerInfo customerInfo);
The createNewCustomer API may be used to create a customer account at the connectivity provider. It may take customer information (e.g., name, address, payment-related details) as input, and return a customer identifier.
[API-2] ConnectionRequestId requestId=requestDirectConnection(CustomerId customerId, ConnectionSpecification connectionSpecification);
The requestDirectConnection API may be used to by a customer to send a request for dedicated connectivity, with various details of the properties of the desired connectivity encapsulated in a ConnectionSpecification object.
[API-3] RequestStatus requestStatus=getConnectionRequestStatus(CustomerID customerId, RequestId requestId);
A customer may use the getConnectionRequestStatus API to query the current status of a connection request—for example, the connectivity provider may indicate in the returned RequestStatus object that the current state is “in-progress”, “completed” or “rejected”. [API-4] ConnectionId connectionId=getConnectionId(CustomerID customerId, RequestId requestId); If a Connection Object is created successfully by the connectivity coordinator (and for example stored in connectivity database 115), a client may use the getConnectionId API to obtain an identifier for that connection object.