ApimaticApolloSDK 0.0.1

Getting Started with apollo-rest-api

Introduction

The Apollo API provides programmatic access to Apollo, the all-in-one sales intelligence and engagement platform. Use it to enrich people and company data (individually or in bulk), search Apollo's database of over 240 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.

Base URL

All API requests are made to https://api.apollo.io/api/v1.

Authentication

• Apollo users authenticate with an API key passed in the x-api-key request header. See Create API Keys.
• Apollo partners building integrations on behalf of mutual users authenticate with the OAuth 2.0 authorization flow.

Rate limits & credits

Rate limits and credit consumption depend on your Apollo pricing plan. Check your current limits and usage with the View API Usage Stats and Rate Limits endpoint. For more details, see Rate Limits and the API FAQs.

New to the API? Start with the Apollo API overview.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimaticApolloSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/ApimaticApolloSDK/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using ApolloRestApi.Standard;
using ApolloRestApi.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

ApolloRestApiClient client = new ApolloRestApiClient.Builder()
    .ApiKeyCredentials(
        new ApiKeyModel.Builder(
            "x-api-key"
        )
        .Build())
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using ApolloRestApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = ApolloRestApiClient
    .FromConfiguration(configuration.GetSection("ApolloRestApi"));

See the Configuration-Based Initialization section for details.

Authorization

This API uses the following authentication schemes.

• apiKey (Custom Header Signature)
• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Emailer Messages
• API
• Enrichment
• Search
• Accounts
• Contacts
• Deals
• Sequences
• Tasks
• Calls
• Conversations
• Analytics
• Miscellaneous

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter