Zig Requires Chilkat v11.0.0+

Get eBay Application Token

See more eBay Examples

This example shows how to request an eBay Application token. Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // See the Ebay documentation about Access token types
    // Also see the Ebay documentation about client credentials grant flow

    const http = try chilkat.Http.init();
    defer http.deinit();

    // If using the sandbox, the target endpoint will be:
    // POST https://api.sandbox.ebay.com/identity/v1/oauth2/token

    // If using the production (live) system, the target endpoint will be:
    // POST https://api.ebay.com/identity/v1/oauth2/token

    // The eBay client_id and client_secret needs to be sent
    // in a Basic Authorization  request header, which has this format:
    // Authorization: Basic <B64_encoded_oauth_credentials>

    // Chilkat takes care of it.  You only need to set the Login = client_id,
    // and password = client_secret, and indicate you want "Basic" HTTP Authorization.
    http.setLogin("EBAY_CLIENT_ID");
    http.setPassword("EBAY_CLIENT_SECRET");
    http.setBasicAuth(true);

    // Let's do the following POST:

    //   HTTP method:   POST
    //   URL (Sandbox): https://api.sandbox.ebay.com/identity/v1/oauth2/token
    //
    //   HTTP headers:
    //     Content-Type = application/x-www-form-urlencoded
    //     Authorization = Basic <B64-encoded-oauth-credentials>
    //
    //   Request body (wrapped for readability):
    //     grant_type=client_credentials&
    //     redirect_uri=<RuName-value>&
    //     scope=<SPACE separated list of scopes>
    //

    // Create an HttpRequest object to hold the request params.
    const req = try chilkat.HttpRequest.init();
    defer req.deinit();
    req.setHttpVerb("POST");
    req.addParam("grant_type", "client_credentials");

    // The scope query param indicates the access to be provided by the token.
    // Multiple scopes can be specified by separating each with a SPACE char.
    // See the Ebay OAuth scopes documentation

    req.addParam("scope", "https://api.ebay.com/oauth/api_scope");

    const end_point = "https://api.sandbox.ebay.com/identity/v1/oauth2/token";
    req.setContentType("application/x-www-form-urlencoded");

    const resp = try chilkat.HttpResponse.init();
    defer resp.deinit();
    http.httpReq(end_point, req, resp) catch {
        std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
        return;
    };

    // The response is JSON..
    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.load(try resp.getBodyStr(alloc)) catch {};
    json.setEmitCompact(false);

    // If the response status code is not 200, then it failed.
    std.debug.print("Response status code = {d}\n", .{resp.getStatusCode()});
    if (resp.getStatusCode() != 200) {
        std.debug.print("{s}\n", .{try json.emit(alloc)});
        std.debug.print("Failed.\n", .{});
        return;
    }

    // We successfully retrieved an eBay access token.
    // The actual access token string can be parsed from the JSON like this:
    _ = try json.stringOf(alloc, "access_token");

    // This application token is only valid for 7200 seconds (2 hours).  We'll want to refresh
    // it before it expires.  (There is an online example for that..)
    // For now, let's save the JSON to a file for our application to use.

    // But before doing that, let's add to the JSON an expiration timestamp
    // so we know when to refresh the token.
    const dt_expire = try chilkat.DateTime.init();
    defer dt_expire.deinit();
    dt_expire.setFromCurrentSystemTime() catch {};
    dt_expire.addSeconds(json.intOf("expires_in")) catch {};
    json.appendString("expire_time", try dt_expire.getAsTimestamp(alloc, false)) catch {};

    // Persist the JSON to a file.
    const fac = try chilkat.FileAccess.init();
    defer fac.deinit();
    fac.writeEntireTextFile("qa_data/tokens/ebay.json", try json.emit(alloc), "utf-8", false) catch {
        std.debug.print("{s}\n", .{try fac.getLastErrorText(alloc)});
        std.debug.print("Failed to save eBay Application token to file.\n", .{});
        return;
    };

    std.debug.print("{s}\n", .{try json.emit(alloc)});
    std.debug.print("Success.\n", .{});

    // The output of this example is:

    //     {
    //       "access_token": "v^1.1#i^1#p^1#I^3#r^0# ... Ajp1BQhJDgAA",
    //       "token_type": "Application Access Token",
    //       "expires_in": 7200,
    //       "refresh_token": "N/A",
    //       "expire_time": "2017-04-16T14:44:20Z"
    //     }
    //
    //     Success.
    //
}