Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oze4/godaddygo
Interact with the GoDaddy API via Golang
https://github.com/oze4/godaddygo
go godaddy godaddy-sdk godaddy-sdk-go godaddy-sdk-golang
Last synced: 2 months ago
JSON representation
Interact with the GoDaddy API via Golang
- Host: GitHub
- URL: https://github.com/oze4/godaddygo
- Owner: oze4
- License: mit
- Created: 2020-08-25T03:56:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T05:47:34.000Z (almost 3 years ago)
- Last Synced: 2024-06-19T00:28:00.403Z (7 months ago)
- Topics: go, godaddy, godaddy-sdk, godaddy-sdk-go, godaddy-sdk-golang
- Language: Go
- Homepage: https://oze4.github.io/godaddygo/
- Size: 427 KB
- Stars: 10
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# [godaddygo](https://oze4.github.io/godaddygo/)
[Check us out on `pkg.go.dev`](https://pkg.go.dev/github.com/oze4/godaddygo?tab=doc)
---
# Table of Contents
- [godaddygo](#godaddygo)
- [Table of Contents](#table-of-contents)
- [Intro](#intro)
- [Installation](#installation)
- [Usage](#usage)
- [Basic Usage](#basic-usage)
- [Custom Client](#custom-client)
- [Extended Example](#extended-example)
- [Features](#features)
---
# Intro
- See [here](#features) for more on which features this package currently supports
- Whenever we reference endpoints, [this is what we are referring to](https://developer.godaddy.com/doc)
Pull requests welcome! We would like to eventually support each GoDaddy Gateway endpoint, not just domain/DNS related tasks
# Installation
- `go get -u github.com/oze4/godaddygo`
- See [here](https://developer.godaddy.com/) for more on how to obtain an Gateway key and Gateway secret from GoDaddy (click 'API Keys')
# Usage
## Basic Usage
Bare minimum what you need to get started (aka how you will typically use this package):
```golang
package main
import (
"github.com/oze4/godaddygo"
)
func main() {
key := ""
secret := ""
// Target production GoDaddy API
// 99% of the time this is what you are looking for
api, err := godaddygo.NewProduction(key, secret)
if err != nil {
panic(err.Error())
}
// Target version 1 of the production API
godaddy := api.V1()
//
// See `Extended Example` section below for more
//
}
```
## Custom Client
```go
package main
import (
"net/http"
"github.com/oze4/godaddygo"
)
func main() {
key := ""
secret := ""
// Target production API (godaddygo.APIDevEnv | godaddygo.APIProdEnv)
target := godaddygo.APIProdEnv
// Build new config
myConfig := godaddygo.NewConfig(key, secret, target)
// Build custom client
myClient := &http.Client{}
// Establish "connection" with API
api, err := godaddygo.WithClient(myClient, myConfig)
if err != nil {
panic(err.Error())
}
// Target version 1 of the production API
godaddy := api.V1()
//
// See `Extended Example` section below for more
//
}
```
# Extended Example
### Regardless of your client, how you actually use this package will be the same either way.
```go
/* We are continuing from within `main()`
* ... pretend code from above is here,
* regardless of your client */
// We now have access to "all" GoDaddy production
// version 1 gateway endpoints (via `godaddy`)
// !! the following is pseudo code !!
foo := godaddy.Domain("foo.com")
bar := godaddy.Domain("bar.com")
// ...more domains...
// Get domain details
foo.GetDetails(ctx)
bar.GetDetails(ctxtwo)
// Anything you can do with `foo`
// you can do with `bar`
// Domain records
fooRecs := foo.Records()
// Do stuff with records
fooRecs.List(ctx)
fooRecs.Add(ctx, someDNSRecord)
fooRecs.FindByType(ctx, godaddygo.RecordTypeA)
// Account related tasks
// View all domains for your account
godaddy.ListDomains(ctx)
// Check availability for domain you don't own
godaddy.CheckAvailability(ctx, "fizz.buzz")
// Purchase domain (this hasn't been tested - it should use the card you have on file)
// I'm not sure what happens when you don't have a card on file =/ lmk
godaddy.Purchase(ctx, myNewDomain)
// etc...
```
# Features
Please see [here](https://developer.godaddygo.com/doc) for more information on GoDaddy Gateway endpoints
- [ ] Abuse
- [ ] Aftermarket
- [ ] Agreements
- [ ] Certificates
- [ ] Countries
- Domains
- [x] Check domain availability
- [x] Get all DNS records
- [x] Get all DNS records of specific type
- [x] Get specific DNS record
- [x] Set DNS record(s)
- [x] Add/create DNS record(s)
- [x] Delete/remove DNS record(s)
- [x] Purchase domain
- [x] Purchase privacy for domain
- [x] Remove privacy for domain
- [ ] Orders
- [ ] Shoppers
- [ ] Subscriptions
---
[mattoestreich.com](https://mattoestreich.com)
---