| name | guidewire-hello-world |
| description | Execute first API calls to Guidewire PolicyCenter, ClaimCenter, and BillingCenter.
Use when testing initial connectivity, exploring API structure,
or making your first insurance data requests.
Trigger with phrases like "guidewire hello world", "first guidewire call",
"test policycenter api", "guidewire api example".
|
| allowed-tools | Read, Write, Edit, Bash(curl:*), Bash(npm:*), Grep |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Guidewire Hello World
Overview
Execute your first API calls to Guidewire InsuranceSuite Cloud APIs - PolicyCenter, ClaimCenter, and BillingCenter.
Prerequisites
- Completed
guidewire-install-auth setup
- Valid OAuth2 access token
- API role permissions for target endpoints
Instructions
Step 1: Test System Connectivity
TOKEN=$(curl -s -X POST "${GW_HUB_URL}/oauth/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=${GW_CLIENT_ID}&client_secret=${GW_CLIENT_SECRET}" \
| jq -r '.access_token')
curl -s "${POLICYCENTER_URL}/common/v1/system-info" \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" | jq
Step 2: Query Accounts (PolicyCenter)
interface Account {
id: string;
accountNumber: string;
accountHolder: {
displayName: string;
};
accountStatus: {
code: string;
};
}
interface AccountsResponse {
data: Account[];
links: {
next?: string;
prev?: string;
};
count: number;
}
async function listAccounts(limit: number = 25): Promise<AccountsResponse> {
const response = await client.request<AccountsResponse>(
'GET',
`/account/v1/accounts?pageSize=${limit}`
);
console.log(`Found ${response.count} accounts`);
response.data.forEach(account => {
console.log(`- ${account.accountNumber}: `);
});
response;
}
Step 3: Create a Submission (PolicyCenter)
interface CreateSubmissionRequest {
data: {
attributes: {
account: { id: string };
baseState: { code: string };
product: { code: string };
producerCode: { id: string };
effectiveDate: string;
};
};
}
interface Submission {
id: string;
jobNumber: string;
status: { code: string };
}
async function createSubmission(
accountId: string,
productCode: string = 'PersonalAuto'
): Promise<Submission> {
const request: CreateSubmissionRequest = {
data: {
attributes: {
account: { id: accountId },
baseState: { code: 'CA' },
product: { code: productCode },
producerCode: { id: },
: (.() + * * * * )
.().()[]
}
}
};
response = client.<{ : }>(
,
,
request
);
.();
response.;
}
Step 4: File a Claim (ClaimCenter)
interface FNOLRequest {
data: {
attributes: {
lossDate: string;
lossType: { code: string };
lossCause: { code: string };
description: string;
reportedDate: string;
policyNumber: string;
};
};
}
interface Claim {
id: string;
claimNumber: string;
status: { code: string };
}
async function createFNOL(policyNumber: string): Promise<Claim> {
const fnol: FNOLRequest = {
data: {
attributes: {
lossDate: new Date().toISOString().split('T')[0],
lossType: { code: 'AUTO' },
lossCause: { code: 'vehcollision' },
: ,
: ().().()[],
: policyNumber
}
}
};
response = client.<{ : }>(
,
,
fnol
);
.();
response.;
}
Step 5: Query Invoices (BillingCenter)
interface Invoice {
id: string;
invoiceNumber: string;
invoiceDate: string;
dueDate: string;
status: { code: string };
amount: { amount: number; currency: string };
}
interface InvoicesResponse {
data: Invoice[];
count: number;
}
async function getAccountInvoices(accountId: string): Promise<InvoicesResponse> {
const response = await client.request<InvoicesResponse>(
'GET',
`${process.env.BILLINGCENTER_URL}/billing/v1/accounts/${accountId}/invoices`
);
console.log(`Found ${response.count} invoices`);
response.data.forEach(invoice => {
console.log(`- : $ due `);
});
response;
}
Gosu Hello World (Server-Side)
// Gosu script to query PolicyCenter data
uses gw.api.database.Query
uses entity.Policy
uses entity.Account
class HelloGuidewire {
static function listActiveAccounts() : List<Account> {
var query = Query.make(Account)
.compare(Account#AccountStatus, Equals, AccountStatus.TC_ACTIVE)
.select()
.toList()
query.each(\account -> {
print("Account: ${account.AccountNumber} - ${account.AccountHolderContact.DisplayName}")
})
return query
}
static function findPoliciesByAccount(accountNumber : String) : List<Policy> {
var account = Query.make(Account)
.compare(Account#AccountNumber, Equals, accountNumber)
.select()
.AtMostOneRow
if (account == null) {
throw new IllegalArgumentException("Account not found: ${accountNumber}")
}
return account.Policies.toList()
}
}
Output
- Successful API response from PolicyCenter
- Account listing with pagination
- Created submission with job number
- FNOL claim creation confirmation
- Invoice listing from BillingCenter
Error Handling
| Error | Cause | Solution |
|---|
404 Not Found | Invalid endpoint or resource ID | Verify endpoint path and ID format |
400 Bad Request | Invalid request payload | Check required fields and data types |
422 Unprocessable | Business rule violation | Review validation errors in response |
409 Conflict | Concurrent modification | Retry with updated checksum |
415 Unsupported Media | Wrong content type | Use application/json |
API Response Structure
All Guidewire Cloud APIs follow this structure:
interface GuidewireResponse<T> {
data: T;
included?: any[];
links?: {
self: string;
next?: string;
prev?: string;
};
count?: number;
}
Common Resource Patterns
GET /account/v1/accounts/{accountId}
GET /account/v1/accounts?filter=accountStatus:eq:Active&pageSize=50
POST /account/v1/accounts
{ "data": { "attributes": { ... } } }
PATCH /account/v1/accounts/{accountId}
{ "data": { "attributes": { ... }, "checksum": "abc123" } }
GET /account/v1/accounts/{accountId}?include=accountHolder,primaryLocation
Examples
Complete Hello World Script
import { GuidewireClient } from './client';
async function main() {
const client = new GuidewireClient(
process.env.GW_CLIENT_ID!,
process.env.GW_CLIENT_SECRET!,
process.env.GW_HUB_URL!,
process.env.POLICYCENTER_URL!
);
try {
console.log('Testing PolicyCenter connectivity...');
const systemInfo = await client.request('GET', '/common/v1/system-info');
console.log('Connected:', systemInfo);
console.log('\nListing accounts...');
const accounts = await client.request('GET', '/account/v1/accounts?pageSize=5');
console.log(`Found ${accounts.count} accounts`);
if (accounts.data.length > ) {
accountId = accounts.[].;
.();
account = client.(, );
.(, .(account, , ));
}
.();
} (error) {
.(, error.?. || error.);
}
}
();
Resources
Next Steps
For local development workflow, see guidewire-local-dev-loop.