Skip to content

Using the CoCore API from Microsoft Excel

Yes, you can even use it in a spreadsheet!

Integrating the CoCore API into an Excel spreadsheet using Visual Basic for Applications (VBA) is achievable by leveraging Excel's built-in capabilities to make HTTP requests. Here's a step-by-step guide to assist you:

1. Enable Microsoft XML, v6.0 Reference

Excel's VBA doesn't natively support HTTP requests, so you'll need to enable the Microsoft XML, v6.0 reference:

  • Open Excel and press Alt + F11 to access the Visual Basic for Applications editor.
  • Navigate to Tools > References.
  • In the list, check Microsoft XML, v6.0.
  • Click OK to confirm.

2. Write the VBA Function

Create a VBA function to send a POST request to the CoCore GraphQL endpoint:

vba
Function FetchJobData(jobId As String) As String
    Dim xml As Object
    Dim url As String
    Dim apiKey As String
    Dim query As String
    Dim response As String

    ' Initialize the XML HTTP object
    Set xml = CreateObject("MSXML2.XMLHTTP.6.0")

    ' CoCore GraphQL endpoint
    url = "$MY_COCORE_URL/graphql"

    ' Your CoCore API key
    apiKey = "YOUR_API_KEY"

    ' GraphQL query
    query = "{""query"":""query GetJob($id: ID!) { job(id: $id) { id name quantity } }"",""variables"":{""id"":""" & jobId & """}}"

    ' Open the HTTP request
    xml.Open "POST", url, False

    ' Set the request headers
    xml.setRequestHeader "Content-Type", "application/json"
    xml.setRequestHeader "Authorization", "Bearer " & apiKey

    ' Send the request with the query
    xml.Send query

    ' Get the response text
    response = xml.responseText

    ' Return the response
    FetchJobData = response
End Function

3. Use the Function in Excel

You can now use the FetchJobData function directly in your Excel cells:

  • In a cell, enter: =FetchJobData("job-id").
  • Replace "job-id" with the actual job ID you wish to query.

The function will return the raw JSON response from the CoCore API.

4. Parse the JSON Response

To extract specific data from the JSON response, you can use a JSON parsing library or write a custom parser. Alternatively, consider using Power Query in Excel, which has built-in support for JSON parsing.

5. Error Handling

Implement error handling to manage potential issues during the HTTP request:

vba
Function FetchJobData(jobId As String) As String
    On Error GoTo ErrorHandler

    ' ... [rest of the function code]

    Exit Function

ErrorHandler:
    FetchJobData = "Error: " & Err.Description
End Function

6. Explore API Documentation

For detailed information on available queries, mutations, and schema definitions, refer to the CoCore API documentation at https://docs.wearecococo.com.

By following these steps, you can integrate the CoCore API into your Excel spreadsheets using VBA, enabling dynamic data retrieval and manipulation directly within Excel.

Connect. Combine. Collaborate.
The pioneering open integration platform, dedicated to transforming connectivity in the printing industry.