Installation

Requirements

The core package, conceptlz/adobe-sign, comes in as a dependency; you don't require it separately. The bundle and the core share one version number and are released together.

Install in six steps

1. Require the bundle

   composer require conceptlz/adobe-sign-symfony

   The package type is symfony-bundle, so Symfony Flex adds it to config/bundles.php for you. There is no recipe, so Flex doesn't create config files; the next steps do that by hand.

2. Register the bundle if Flex didn't

   return [
       Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
       // ...
       Conceptlz\AdobeSign\Symfony\AdobeSignBundle::class => ['all' => true],
   ];

   Register it in every environment. Disabling it in test would remove the services your tests need; swap the HTTP client instead (see Testing).

3. Make sure a PSR-18 client exists

   composer require symfony/http-client nyholm/psr7

   Skip this if your app already has symfony/http-client and a PSR-17 implementation. Details in the HTTP client.

4. Put the key in the environment

   Declare the variable (empty) in the committed .env and give it a value in .env.local, which is git-ignored. See credentials.

5. Create the configuration and import the routes

   Two small YAML files: config/packages/adobe_sign.yaml and config/routes/adobe_sign.yaml. See the config file and importing the routes.

6. Verify

   php bin/console adobe-sign:verify

   It calls Acrobat Sign with your credentials and prints who they belong to. See checking the connection.

The HTTP client (PSR-18)

The core SDK never creates its own HTTP stack. It accepts any PSR-18 client, which keeps it framework-free and lets your tests swap in a fake. The bundle decides which client to hand it in this order:

1. The service named in adobe_sign.http_client, if you set one.
2. Otherwise the framework's PSR-18 client, service psr18.http_client. FrameworkBundle registers it when symfony/http-client is installed together with a PSR-17 implementation such as nyholm/psr7. It inherits your framework.http_client settings (timeouts, proxies, retry options).
3. Otherwise php-http/discovery looks for any installed PSR-18 client, for example Guzzle 7.

The PSR-17 request and stream factories are always found by discovery, which is why nyholm/psr7 (or guzzlehttp/psr7) must be installed. If nothing can be found, the first API call throws Http\Discovery\Exception\NotFoundException; see Troubleshooting.

framework:
    http_client:
        default_options:
            timeout: 10          # seconds to wait for the first byte
            max_duration: 120    # large signed PDFs can take a while

Credentials in the environment

Acrobat Sign accepts two kinds of credentials, and the bundle supports both. Pick one now; you can add the other later.

Integration Key or OAuth?

Create an Integration Key in Acrobat Sign under Account → Acrobat Sign API → API Information → Integration Key. Give it the scopes your app needs (at least agreement_read, agreement_write, agreement_send, user_login, and webhook_read/webhook_write if you register webhooks).

###> conceptlz/adobe-sign-symfony ###
ADOBE_SIGN_INTEGRATION_KEY=
ADOBE_SIGN_CLIENT_ID=
ADOBE_SIGN_CLIENT_SECRET=
###< conceptlz/adobe-sign-symfony ###

ADOBE_SIGN_INTEGRATION_KEY=3AAABLblqZhB...your-key...
# Only for OAuth or webhooks:
ADOBE_SIGN_CLIENT_ID=CBJCHBCAABAA...
ADOBE_SIGN_CLIENT_SECRET=...

Declaring the variables empty in .env matters: a %env(ADOBE_SIGN_INTEGRATION_KEY)% reference to an undefined variable throws EnvNotFoundException when the container builds the manager, while an empty one gives you the bundle's clearer MisconfiguredException that names the setting. On servers, prefer real environment variables or Symfony secrets:

php bin/console secrets:set ADOBE_SIGN_INTEGRATION_KEY --env=prod

The config file

The bundle's configuration root is adobe_sign. For an Integration Key, one line is enough; every other key has a default.

adobe_sign:
    integration_key: '%env(ADOBE_SIGN_INTEGRATION_KEY)%'

adobe_sign:
    auth: oauth
    oauth:
        client_id: '%env(ADOBE_SIGN_CLIENT_ID)%'
        client_secret: '%env(ADOBE_SIGN_CLIENT_SECRET)%'
        token_store: doctrine          # or keep "cache" with a persistent pool
        redirect_after: /settings/integrations

See Configuration for every key, its default and what it changes. Two defaults are worth knowing now: cache_pool and oauth.token_cache_pool are both cache.app. That is fine on one machine, but on several servers or for OAuth tokens you want a shared, persistent pool; see cache and HTTP.

Importing the routes

The bundle ships its routes as PHP files but doesn't load them by itself, so you decide which ones exist and under which prefix.

# Everything: OAuth connect routes and the webhook
adobe_sign:
    resource: '@AdobeSignBundle/config/routes.php'

# Or pick one:
# adobe_sign_oauth:
#     resource: '@AdobeSignBundle/config/routes/oauth.php'
# adobe_sign_webhook:
#     resource: '@AdobeSignBundle/config/routes/webhook.php'

Add prefix: /integrations to an import to move its paths; the route names stay the same, and the default OAuth redirect URI follows the callback route automatically. Check the result with:

php bin/console debug:router | grep adobe_sign

Using only an Integration Key and no webhooks? Then you don't need to import anything: the services work without routes.

Checking the connection

$ php bin/console adobe-sign:verify

 [OK] Connected to Acrobat Sign.

 ---------------- -------------------------
  User             sender@example.com
  Account admin    yes
  Account          CBJCHBCAABAA...
 ---------------- -------------------------

The command calls GET /users/me with the default client. The first call of a fresh app also discovers the account's data centre through GET /baseUris and caches it in cache_pool. On any SDK error it prints the SDK's message (for example INVALID_ACCESS_TOKEN) and exits with status 1, so you can run it in a deploy pipeline as a smoke test. It never prints the key.

For OAuth, check one user's connection by their token key, which is their user identifier by default:

php bin/console adobe-sign:verify --user=jane@example.com

Optional pieces

The bundle has hard dependencies only on Symfony components every full-stack app already has. Three features need more, and the bundle registers their services only when you configure them.

Doctrine DBAL, for a token table

composer require doctrine/dbal          # usually via symfony/orm-pack

Needed only for oauth.token_store: doctrine. With Doctrine ORM installed as well, the table is added to the ORM schema so doctrine:migrations:diff generates its migration; without the ORM, run php bin/console adobe-sign:create-token-table. See Token storage & Doctrine.

Symfony Messenger, for async webhooks

composer require symfony/messenger

Needed only for webhooks.messenger. Enabling it without Messenger installed fails the container build with a missing messenger.default_bus service, which is deliberate: a silently ignored setting would lose notifications. See Async with Messenger.

Symfony Security, for OAuth

composer require symfony/security-bundle

The OAuth callback stores tokens under the signed-in user, which it reads from security.token_storage. Without SecurityBundle there is never a signed-in user, so the callback answers 401. Your app also needs sessions enabled (framework.session), because the single-use OAuth state lives there. See protecting the routes.

Upgrading

Before 1.0, a minor version (0.5 → 0.6) may contain breaking changes; patch versions don't. Update the bundle and the core together, read the changelog, clear the cache and restart workers:

composer update conceptlz/adobe-sign-symfony conceptlz/adobe-sign --with-dependencies
php bin/console cache:clear
php bin/console messenger:stop-workers

Common questions

• ConfigurationEvery key of the adobe_sign tree, its default and its effect.
• Using the clientInject the client, send your first agreement, handle errors.