PHPackages                             vendasta/godaddy - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. vendasta/godaddy

ActiveLibrary

vendasta/godaddy
================

PHP library for Vendasta's Godaddy service

0.2.0(5y ago)0119[1 issues](https://github.com/vendasta/godaddy-php-sdk/issues)PHP

Since Jul 21Pushed 3y ago28 watchersCompare

[ Source](https://github.com/vendasta/godaddy-php-sdk)[ Packagist](https://packagist.org/packages/vendasta/godaddy)[ RSS](/packages/vendasta-godaddy/feed)WikiDiscussions master Synced 6d ago

READMEChangelog (3)Dependencies (7)Versions (7)Used By (0)

Vendasta GoDaddy PHP SDK
========================

[](#vendasta-godaddy-php-sdk)

Description
-----------

[](#description)

This is Vendasta's official PHP SDK for API integration of GoDaddy.

Requirements
------------

[](#requirements)

- PHP 5.5 and above or PHP 7.0 and above
- [PECL](https://pecl.php.net/) (may be used to install the required PHP extensions)
- [Composer](https://getcomposer.org/)
- [PHP gmp extension](http://php.net/manual/en/book.gmp.php)
- OPTIONAL (but recommended): [PHP grpc extension](https://cloud.google.com/php/grpc)

Installation
------------

[](#installation)

Install the requirements from above, then:

```
composer require vendasta/godaddy
```

Authentication
--------------

[](#authentication)

To authenticate your SDK calls, you must provision a service account from within the Vendasta platform. Refer to the [service account guide](https://developers.vendasta.com/guides/service-accounts) in order to setup authentication.

You must put this file on your server, and set an environment variable to it's path:

```
export VENDASTA_APPLICATION_CREDENTIALS=
```

Client Initialization
---------------------

[](#client-initialization)

It is highly recommended that you use a singleton client instance. Each client initilization will open it's own connection, therefore using a singleton results in reusing a connection, saving time and resources.

Set an environment variable:

```
export ENVIRONMENT=
```

To instantiate the client:

```
$environment = getenv("ENVIRONMENT");
if ($environment == null) {
    $environment = "DEMO";
}

$client = new Vendasta\Godaddy\V1\GoDaddyClient($environment);
```

Notice that the environment will be set to DEMO if it is not specified.

Provisioning a GoDaddy account
------------------------------

[](#provisioning-a-godaddy-account)

Provisioning a new GoDaddy account can be done using the [Account Group SDK](https://packagist.org/packages/vendasta/accountgroup) and [Sales Orders SDK](https://packagist.org/packages/vendasta/sales-orders). The Account Group SDK is used to create business accounts in Partner Center. Follow the readme for installation and setup. Create is synchronous. It immediately creates the account and returns the account group ID for the business you made (used as the business ID in the other SDKs). After a business is created you can use the Sales Orders SDK to purchase products on that business using the business ID from the Account Group SDK. CreateAndActivateOrder is an asynchronous process which can result in approval or rejection from the vendor. The status of the order can be polled using the GetSalesOrder endpoint given the order ID from CreateAndActivateOrder.

Production App ID: MP-4TMLZSQ5FMJQX5T75TPC43FQBWD2VXLB

Demo environment App ID: MP-NNTJMBF6HPXR5XXC2JKCFWKJ64VZLBFQ

```
// Choose environment and partnerId
$env = "DEMO";
$pid = "";

// Instantiate clients
$accountGroupClient = new AccountGroupServiceClient($env);
$salesOrdersClient = new SalesOrdersClient($env);

// Build request to create a business
$createReq = new CreateAccountGroupRequest();
$location = new AccountGroupLocation();
$location->setCompanyName("Test Company");
$location->setAddress("123 Street Name");
$location->setCity("Chicago");
$location->setState("IL");
$location->setCountry("US");
$location->setZip("88888");
$workNumber = array("(999) 999-9999");
$location->setWorkNumber($workNumber);
$createReq->setAccountGroupNap($location);
$createReq->setPartnerId($pid);

// Make call and store returned accountGroupId
$resp = $accountGroupClient->Create($createReq);
$accountGroupId = $resp->getAccountGroupId();

// Build sales order request & activate the products
// Create the request
$req = new CreateAndActivateOrderRequest();

// Create the line items
$goDaddy = SalesOrdersUtils::buildLineItem('MP-NNTJMBF6HPXR5XXC2JKCFWKJ64VZLBFQ');
$lineItems = array($goDaddy);

// Create the custom fields
$goDaddyCustomField = SalesOrdersUtils::buildGoDaddyCustomFields("MP-NNTJMBF6HPXR5XXC2JKCFWKJ64VZLBFQ", "testdomain123.com", "example@email.com", "First", "Last", "3065555555", "example@email.com", "First", "Last");
$customFields = array($goDaddyCustomField);

// Create the order
$order = SalesOrdersUtils::buildOrder($pid, $accountGroupId, $lineItems, $customFields);
$req->setOrder($order);

// Call CreateAndActivateOrder
$resp = $salesOrdersClient->CreateAndActivateOrder($req);

// Poll the pending activation process using GetSalesOrder
```

Deprovision an account
----------------------

[](#deprovision-an-account)

```
// Choose environment and partnerId
$env = "DEMO";
$pid = "";

// Select the app ID and business ID to deactivate
$businessId = "";
$appId = "";

// The activation ID will be populated after we list all the products on the business
$activationId = "";

$client = new AccountsServiceClient($env);

// First list all of the current products activated for that business and find the one matching the appID
$listReq = new ListRequest();
$listReq->setPartnerId($pid);
$listReq->setBusinessId($businessId);
$resp = $client->List($listReq);
foreach($resp->getAccounts() as $account) {
    if ($account->getAppId() == $appId) {
        // The activation ID is necessary for deactivating an app
        $activationId = $account->getActivationId();
    }
}

// Build the deactivation request with the activation ID
$deactivationReq = new DeactivateAppRequest();
$deactivationReq->setBusinessId($businessId);
$deactivationReq->setAppId($appId);
$deactivationReq->setActivationId($activationId);
$deactivationReq->setDeactivationType(DeactivationType::DEACTIVATION_TYPE_CANCEL);
```

How to use this SDK
-------------------

[](#how-to-use-this-sdk)

### Getting domain availability

[](#getting-domain-availability)

```
$req = new Godaddy\V1\GetDomainAvailableRequest();
$req->setDomain("");
$resp = $client->GetDomainAvailable($req);
```

### Patching domains

[](#patching-domains)

This can be used to lock or unlock a domain

```
$req = new PatchDomainRequest();
$req->setDomain("example.com");
$fieldMask = new FieldMask();
$paths = ["locked"];
$fieldMask->setPaths($paths);
$req->setFieldMask($fieldMask);
$req->setLocked(false);
$resp = $client->PatchDomain($req);
```

### Getting domain details

[](#getting-domain-details)

This can be used to get details about a domain including the AuthCode

```
$req = new GetDomainRequest();
$req->setDomain("example.com");
$resp = $client->GetDomain($req);
```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 57.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~70 days

Total

4

Last Release

1914d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1498d6f30e570d34309cfb7c848cb3b80d0eca6bd8e28af9d5db3f4196b300bb?d=identicon)[vendasta](/maintainers/vendasta)

---

Top Contributors

[![ParkerReese](https://avatars.githubusercontent.com/u/28064536?v=4)](https://github.com/ParkerReese "ParkerReese (11 commits)")[![kamundson-va](https://avatars.githubusercontent.com/u/15634999?v=4)](https://github.com/kamundson-va "kamundson-va (5 commits)")[![bbudz-va](https://avatars.githubusercontent.com/u/19170994?v=4)](https://github.com/bbudz-va "bbudz-va (2 commits)")[![avadan1](https://avatars.githubusercontent.com/u/83599192?v=4)](https://github.com/avadan1 "avadan1 (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/vendasta-godaddy/health.svg)

```
[![Health](https://phpackages.com/badges/vendasta-godaddy/health.svg)](https://phpackages.com/packages/vendasta-godaddy)
```

###  Alternatives

[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)[google/cloud

Google Cloud Client Library

1.2k16.2M53](/packages/google-cloud)[temporal/sdk

Temporal SDK

4002.2M18](/packages/temporal-sdk)[google/grpc-gcp

gRPC GCP library for channel management

18497.8M3](/packages/google-grpc-gcp)[googleads/google-ads-php

Google Ads API client for PHP

3497.6M9](/packages/googleads-google-ads-php)[spiral/grpc-client

gRPC client

41140.3k2](/packages/spiral-grpc-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)